constructSYB {FAOSTAT} | R Documentation |
Construct/Creat new variable.
Description
A function used to construct new variables from existing variables.
Usage
constructSYB(
data,
origVar1,
origVar2,
newVarName = NA,
constructType = c("share", "growth", "change", "index"),
grFreq = 1,
grType = c("ls", "geo"),
baseYear = 2000
)
Arguments
data |
The data frame containing the raw variable |
origVar1 |
The variable name to be used in construction, refer to Details for more information and useage. |
origVar2 |
The variable name to be used in construction, refer to Details for more information and useage. |
newVarName |
The name assigned to the new variable, if missing then .SC/.SH/.GR/.CH will be appended depending on the type of construction |
constructType |
The type of construction, refer to Details for more information. |
grFreq |
The frequency for the growth rate to be computed. |
grType |
The method for the growth to be calculated, currently supports least squares and geometric. |
baseYear |
The base year to be used for constructing index. |
Details
Currently two types of construction are supported, either share or growth rate computation.
Share can be a share of total or share of another variable depending on whether an additional variable is supplied or not.
Value
A data frame containing both the original data frame and the processed data and also a list indicating whether the construction passed or failed.