nonmemica (version 1.0.8)

definitions: Harvest Model Item Definitions

Description

Havests model item definitions.

Create Item Definitions from Model Name

Usage

definitions(x, ...)
# S3 method for character
definitions(
  x,
  verbose = FALSE,
  ctlfile = modelfile(x, ...),
  metafile = modelpath(x, "def", ...),
  fields = getOption("fields", default = c("symbol", "label", "unit")),
  read = length(metafile) == 1,
  write = FALSE,
  ...
)

Value

object of class definitions, or path to metafile if write = TRUE.

Arguments

x

object of dispatch

...

arguments to methods

verbose

set FALSE to suppress messages

ctlfile

path to control stream (pass length-zero argument to ignore)

metafile

path to definitions file (pass length-zero argument to ignore)

fields

metadata fields to read from control stream if no metafile

read

whether to read the definitions file

write

whether to write the definitions file

Methods (by class)

• definitions(character): character method

Details

x can be numeric or character model name, assuming project is identified by argument or option.

Creates item definitions from a model name. Scavenges definitions optionally from the control stream and optionally from the definitions file. Optionally writes the result to the definitions file. Always returns a data.frame with at least the column 'item' but possibly no rows.

See Also

definitions.character

as.xml_document.character

as.bootstrap.character

as.model.character

Other definitions: definitions.definitions(), definitions.numeric()

Other definitions: definitions.definitions(), definitions.numeric()

Examples

library(magrittr)
options(project = system.file('project/model',package='nonmemica'))
1001 %>% definitions