createStandardMetadata: Generate standard metadata for EpiJSON

Description Usage Arguments Note Author(s)

View source: R/helpers.R

Description

Provide an ejMetadata object with standard metadata. In large part these follow the reccomendations of the NetCDF CF convention with a few additional parameters to help with dataset and model validation.

Usage

1
2
3
4
createStandardMetadata(title, generatorName,
  generatorLongName = generatorName, generatorVersion = "", dataSource,
  institution = "", history = "", runUUID = generateUUID(),
  parameters = list(), references = "", comment = "")

Arguments

title

A succinct description of what is in the file

generatorName

The short name of the program. This should be URL friendly. This will appear in the 'generatorName' attribute and may be used in other systems to provide web access to results.

generatorLongName

Ideally this is descriptive of what the generator is and does. This will appear in the 'history' attribute.

generatorVersion

The version of the generator.

dataSource

Free text for the source parameter. Where did this data come from?

institution

Where this data was produced?

history

This attribute within the EpiJSON file provides an audit trail for the file. Provide previous history here, a timestamp followed by the generator name, generator version, username and machine name will be added at the bottom.

runUUID

a Universally Unique IDentifier for this generator run. Must follow the Open Software Foundation UUID standard. Will be used for the runUUID attribute.

parameters

The parameters that the generator was run with. A named list is expected and this will be used to fill in the parameters attributes.

references

Published or web based references that describe the data or the methods used to produce it.

comment

Free text for additional comments.

Note

This function will generate the following attributes:

Author(s)

Tom Finnie (Thomas.Finnie@phe.gov.uk)


Hackout2/repijson documentation built on May 6, 2019, 9:48 p.m.