Parameter_Global_Year: Transform a set of parameters from Year to global effect, or...

Description Usage Arguments Details Value Author(s) Examples

View source: R/Parameter_Global_Year.R

Description

This function is used to transform a set of parameters that uses Peak, LengthB, LengthE, B, E, or Length to the same parameter with Year effect, or reverse.
The parameter series can be or a result from add_phenology() or from fit_phenology() or simply a vector of names.

Usage

1
2
3
4
5
6
7
Parameter_Global_Year(
  parameters = stop("A set of parameters must be indicated"),
  parname = c("Peak", "LengthB", "LengthE", "B", "E", "Length"),
  series = NULL,
  sep_year = "-",
  perYear = TRUE
)

Arguments

parameters

Set of current parameters

parname

Name of parameter to transform

series

Set of series (see description)

sep_year

Character used to separate the year

perYear

TRUE if year-specific values must be setup

Details

Parameter_Global_Year transforms a set of parameters from Year to global effect, or reverse

Value

Return a set of modified parameters

Author(s)

Marc Girondot

Examples

1
2
3
4
5
6
7
8
## Not run: 
Parameter_Global_Year(parameters=c("Peak_Beach1-2018"=151, "Peak_Beach1-2019"=161), 
                     parname="Peak", perYear=FALSE)
Parameter_Global_Year(parameters=c("Peak"=151), 
                      series = c("beach1", "beach2"), 
                     parname="Peak", perYear=TRUE)

## End(Not run)

phenology documentation built on Oct. 23, 2020, 7:22 p.m.