hollorol/RBBGCMuso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update outputMapping.R

Browse Source 
Updated doc
This commit is contained in:
Zoltán BARCZA 2019-01-24 13:48:58 +01:00 committed by GitHub
parent 1512832ce3
commit 580f54f3b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
RBBGCMuso/R/outputMapping.R
View File

@ -1,9 +1,9 @@
#' updateMusoMapping #' updateMusoMapping
#' #'
#' This function update the the muso outputcode-variable matrix #' 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 #' @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 #' @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 outputcode-variable matrix, and also change the global variable #' @return The output code-variable matrix, and also the function changes the global variable
#' @export #' @export
#' @usage updateMusoMapping(output_map_init="output_map_init.c") #' @usage updateMusoMapping(output_map_init="output_map_init.c")
@ -20,11 +20,11 @@ updateMusoMapping<-function(output_map_init="output_map_init.c"){
#' musoMapping #' musoMapping
#' #'
#' musoMapping can give us the name of a muso outputcode #' 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 #' @author Roland HOLLOS
#' @param code the MuSo outputcode #' @param code the MuSo outputcode
#' @param mapData updateMusomapping generated matrix #' @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 #' @export
#' @usage musoMapping(code, mapData=NULL) #' @usage musoMapping(code, mapData=NULL)
@ -40,10 +40,10 @@ musoMapping <- function(code, mapData=NULL){
#' musoMappingFind #' musoMappingFind
#' #'
#' musoMapping can give us the name of a muso outputcode #' 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 #' @author Roland HOLLOS
#' @param variable If null return the whole mapping, else search a variable code #' @param variable If this is null, return the whole mapping table. In other cases search for the variable code
#' @return The code of th specific name #' @return The code of the specific output variable name
#' @export #' @export
#' @usage musoMapping(code, mapData=NULL) #' @usage musoMapping(code, mapData=NULL)