getIdentifier: .getIdentifier

Description Usage Arguments Details Value Author(s) See Also Examples

Description

Function to get the identifier for the call of the function from the magpie library to a dataset in the validation database.

Usage

1
2
.getIdentifier(func, ..., ignore.args=NULL, choose.args=NULL,
               get=TRUE, return_arguments=FALSE)

Arguments

func

Name of the magpie library function that this data belongs to.

...

Values for arguments that func takes. If an argument is not specified the default value are used. The two arguments "file" and "level" can be omitted without causing problems.

ignore.args

A vector of strings, specifying arguments for which it does not matter what value they have.

choose.args

A vector of strings. A call of func with a certain value of these arguments requires to return argument specific data from the database (e.g. crops in production).

get

Boolean specifying if the function is called to get Data from the database (TRUE) or to add it (FALSE).

return_arguments

Boolean. If FALSE, the identifier is returned, if TRUE, the list of arguments os returned.

Details

The function determines the identifier for func(...) .

Value

A string with the identifier if return_arguments=FALSE, a list with the arguments otherwise.

Author(s)

Markus Bonsch

See Also

validationPlot,getData,.loadData,addData,add_aggrType,show_aggrTypes,.chooseCollection,addMapping,.chooseIdentifier

Examples

1
  ## Not run: test<-.getIdentifier(func=land,types="crop",sum=FALSE,ignore.args="sum",choose.args="siclass")

pik-piam/validation documentation built on Nov. 5, 2019, 12:50 a.m.