magclass (version 4.107.0)

write.report2: Write file in report format

Description

This function writes the content of a MAgPIE object into a file or returns it directly using the reporting format as it is used for many model intercomparisons. It is a rewritten version of write.report and will probably replace write.report somewhen in the future

Usage

write.report2(x, file = NULL, model = NULL, scenario = NULL,
  unit = NULL, ndigit = 4, append = FALSE, skipempty = TRUE,
  extracols = NULL)

Arguments

x

MAgPIE object or a list of lists with MAgPIE objects as created by read.report. In the latter case settings for model and scenario are overwritten by the information given in the list.

file

file name the object should be written to. If NULL the formatted content is returned

model

Name of the model which calculated the results

scenario

The scenario which was used to get that results.

unit

Unit of the data. Only relevant if unit is not already supplied in Dimnames (format "name (unit)"). Can be either a single string or a vector of strings with a length equal to the number of different data elements in the MAgPIE object

ndigit

Number of digits the output should have

append

Logical which decides whether data should be added to an existing file or an existing file should be overwritten

skipempty

Determines whether empty entries (all data NA) should be written to file or not.

extracols

names of dimensions which should appear in the output as additional columns

See Also

read.report

Examples

# NOT RUN {
data(population_magpie)
write.report2(population_magpie)

# }