-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
99 lines (66 loc) · 4.13 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# duflor <a href="https://github.com/Claudius-Appel/duflor/"><img src="man/figures/logo.png" alt="duflor website" align="right" height="139"/></a>
<!-- badges: start -->
[](https://github.com/Claudius-Appel/duflor/actions/workflows/R-CMD-check.yaml) [](https://app.codecov.io/gh/Claudius-Appel/duflor?branch=master)
<!-- badges: end -->
## Overview
Duflor is a package to detect and quantify number of pixels in any subrange(s) of HSV-color space declared by an upper and lower bound. While the package is principally task-agnostic and could work on any sort of HSV-range(s), it is developed for the detection and quantification of plant area.
## Installation
You can install the development and release versions of `duflor` like so:
``` r
# release
devtools::install_github("https://github.com/Claudius-Appel/duflor@master")
# development
devtools::install_github("https://github.com/Claudius-Appel/duflor@dev")
```
If help-vignettes are to be downloaded, use instead:
``` r
devtools::install_github("https://github.com/Claudius-Appel/duflor@master"
,build_vignettes = T)
devtools::install_github("https://github.com/Claudius-Appel/duflor@dev"
,build_vignettes = T)
```
Vignettes are rendered documents discussing specific topics within a package. Installing them is recommended, but not required for utilising the package itself.
**If the front-end shiny-application within the `duflor_gui`-package is to be used, it is strongly recommended to follow the installation-guide for that package instead.**
### Prerequisites
Installing this package from GitHub requires the installation of the R-package `devtools`:
``` r
install.packages("devtools")
```
#### Install R-build-toolchain {#install-rbuild-chain}
This package contains C++ code. As it is distributed as source-code, users will require the appropriate R-build-toolchain for their respective operating system. For further information and setup-instructions, refer to "<https://r-pkgs.org/setup.html#setup-tools>".
For windows, the R-package `installr` may be used to check if Rtools is already installed, and whether or not it has been found by R. Additionally, it will notify the user if a new R-update is available (major and minor versions only, ignores patch versions):
``` r
install.packages("installr") # once pkgbuild is installed, run:
installr::install.Rtools(check = T,check_r_update = T,GUI = T)
```
### {data-link="Installation-steps"}
## Usage
For detailed documentation, refer to <https://claudius-appel.github.io/duflor/>
Additionally, various topics have more detailed articles, accessible on the aforementioned website, as well as within R via `browseVignettes()`. While access from within R is possible, it is generally recommended to view the articles via the website.
### A small sidenote on options set by duflor:
Upon loading, duflor will set the following options via `options(XX)`:
- `duflor.default_hsv_spectrums`: default HSV-ranges for
- drought leaf-area
- green leaf-area
- complete leaf-area
- identifier area
- `duflor.default_identifier_area`: the size of the `identifier_dot` in [cm\^2].
Their values can be retrieved via `getOption(option)`:
``` r
getOption("duflor.default_hsv_spectrums")
getOption("duflor.default_identifier_area")
```
- `duflor.default_hsv_spectrums` is merely used as a shortcut to load the currently-set default hsv ranges. It is not intended to be modified; as it serves no internal use.
- `duflor.default_identifier_area` is more likely to require modification. Before calculating the area for each spectrum via `duflor::pixels_to_area(pixel.counts)`, the true area of the identifier-dot must be set via this option. The default is set to `r 0.503`. All areas are assumed to be in [cm\^2].