Description Usage Arguments Note Author(s)
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.
1 2 3 4 | createStandardMetadata(title, generatorName,
generatorLongName = generatorName, generatorVersion = "", dataSource,
institution = "", history = "", runUUID = generateUUID(),
parameters = list(), references = "", comment = "")
|
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. |
This function will generate the following attributes:
title A brief title for the dataset.
institution Where the dataset was produced.
source The source of the data the generator used.
history The history of the dataset.
references Published references for data or methods.
comment Free text commentary on the data.
runUUID A unique identifier for a run.
parameters Attributes containing parameters used for this generator run (they take their name from the names in the list with paramer_ prepended).
runtime A record of the R session (version and attached libraries) at the point of invoking this command.
Tom Finnie (Thomas.Finnie@phe.gov.uk)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.