greenwave
Source
greenwave
R package for fitting the greenwave model to time series of vegetation indices
Installation
You can install the development version of greenwave with:
devtools::install_gitlab("apis-staging/greenwave")
Usage
For deploymenet in non-interactive settings, batch runs, automated testing of various parameterizations, CI / CD etc. see the Greenwave Command Line Tool:
Rscript demo/gw-cli.R --help
Rscript demo/gw-sim.R --incl_sim_opts --n_locs 8
Note that we have repurposed the demo directory for internal use, including simulation, conceptual diagrams, DAGs, etc. We make unapologetic use of some of the package's internal functions, and point would-be users instead to the vignettes.
Abbreviations
The following abbreviations (including their invocation as prefixes / suffixes) are used throughout the package.
| Abbreviation | Short for | Definition / example |
|---|---|---|
n | number | The number of years, n_years |
gw | greenwave | prefix for all functions exported by the package |
re | random effects | |
sf | scaling factors | |
sd / sds | standard deviation(s) | |
id | ID | alphanumeric identifier |
idx | index | sequential integer |
loc | location | |
opts | options | |
cal | calendar | Used exclusively to distinguish between calendar (e.g., 1984, 1985, ..., 2002) and relative years (0, 1, ..., 18) |
incl | include | |
excl | exclude | excl_param |
Licensing and attribution
All material housed in this repository is licensed under the GPLv3 license expect for the data-raw/figures directory, whose contents are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. When making use of those figures please link to this repository and note that the copyright is held by Conservation Science Partners, Inc.