diff --git a/RBBGCMuso/R/outputMapping.R b/RBBGCMuso/R/outputMapping.R index 46fd27c..bb148b7 100644 --- a/RBBGCMuso/R/outputMapping.R +++ b/RBBGCMuso/R/outputMapping.R @@ -1,9 +1,9 @@ #' updateMusoMapping #' -#' This function update the the muso outputcode-variable matrix -#' @author Roland Hollos -#' @param output_map_init The outputcode-variable bindings is described in output_map_init.c file, via this parameter, you can give it the the function -#' @return The outputcode-variable matrix, and also change the global variable +#' This function updates the muso output code-variable matrix. Within Biome-BGCMuSo the state variables and fluxes are marked by integer numbers. In order to provide meaningful variable names (e.g. 3009 means Gross Primary Production) a conversion table is needed which is handled by this function. +#' @author Roland HOLLOS +#' @param output_map_init The output code-variable bindings are described in output_map_init.c file that is part of the current Biome-BGCMuSo source code. Using this function the user can read the output_map_init.c file and pass it to RBBGCMuso for further work. +#' @return The output code-variable matrix, and also the function changes the global variable #' @export #' @usage updateMusoMapping(output_map_init="output_map_init.c") @@ -20,11 +20,11 @@ updateMusoMapping<-function(output_map_init="output_map_init.c"){ #' musoMapping #' -#' musoMapping can give us the name of a muso outputcode -#' @author Roland Hollos +#' musoMapping can provide the user the name of a Biome-BGCMuSo output code. Within Biome-BGCMuSo the state variables and fluxes are marked by integer numbers. In order to provide meaningful variable names (e.g. 3009 means Gross Primary Production) a conversion table is needed which is utilized by this function. This function converts variable codes into names musoMappingFind does the opposite. +#' @author Roland HOLLOS #' @param code the MuSo outputcode #' @param mapData updateMusomapping generated matrix -#' @return The name of the MuSo outputcode +#' @return The name of the Biome-BGCMuSo output code (e.g. if code is 3009 this function should return GPP to the user) #' @export #' @usage musoMapping(code, mapData=NULL) @@ -40,10 +40,10 @@ musoMapping <- function(code, mapData=NULL){ #' musoMappingFind #' -#' musoMapping can give us the name of a muso outputcode -#' @author Roland Hollos -#' @param variable If null return the whole mapping, else search a variable code -#' @return The code of th specific name +#' musoMappingFind can provide us the code of the Biome-BGCMuSo output variable name. Within Biome-BGCMuSo the state variables and fluxes are marked by integer numbers. In order to provide meaningful variable names (e.g. 3009 means Gross Primary Production) a conversion table is needed which is utilized by this function. This function converts variable names into codes. musoMapping does the opposite. +#' @author Roland HOLLOS +#' @param variable If this is null, return the whole mapping table. In other cases search for the variable code +#' @return The code of the specific output variable name #' @export #' @usage musoMapping(code, mapData=NULL)