nassa-schema.json

[
 {
   "field": "id",
   "level": 0,
   "parent": "",
   "description": "Module identification number. Assigned when opening a submission.",
   "type": "String",
   "format": "YEAR-FIRSTAUTHORSURNAME-999",
   "mandatory": true
 },
 {
   "field": "nassaVersion",
   "level": 0,
   "parent": "",
   "description": "Latest version of the NASSA schema that applies to this module (NASSA.yml fields, directory and file structure). ",
   "type": "String",
   "format": "1.0.0 (semantic versioning)",
   "mandatory": true
 },
 {
   "field": "moduleType",
   "level": 0,
   "parent": "",
   "description": "Whether a algorithm or a submodel (contain modules)",
   "type": "String",
   "format": "Algorithm, Submodel",
   "mandatory": true
 },
 {
   "field": "title",
   "level": 0,
   "parent": "",
   "description": "Module name or title. It must include a useful description of module.",
   "type": "String",
   "format": "free text, max. 100",
   "mandatory": true
 },
 {
   "field": "moduleVersion",
   "level": 0,
   "parent": "",
   "description": "Current version identifier. Defaults to \"1.0.0\" and should increase after every update.",
   "type": "String",
   "format": "1.0.0 (semantic versioning)",
   "mandatory": true
 },
 {
   "field": "contributors",
   "level": 0,
   "parent": "",
   "description": "List of contributors to the module",
   "type": "",
   "format": "",
   "mandatory": true
 },
 {
   "field": "roles",
   "level": 1,
   "parent": "contributors",
   "description": "How this author contributed to the module (specific labels, see \"format\" column)",
   "type": "Array",
   "format": "Author, Compiler, Contributor, Copyright Holder, Creator, Thesis Advisor, Translator (https://journal.r-project.org/archive/2012-1/RJournal_2012-1_Hornik~et~al.pdf)",
   "mandatory": true
 },
 {
   "field": "name",
   "level": 1,
   "parent": "contributors",
   "description": "Full name of a contributor",
   "type": "String",
   "format": "SURNAME, NAME with no accent marks",
   "mandatory": true
 },
 {
   "field": "email",
   "level": 1,
   "parent": "contributors",
   "description": "Stable email of a contributor",
   "type": "String",
   "format": "valid email",
   "mandatory": true
 },
 {
   "field": "orcid",
   "level": 1,
   "parent": "contributors",
   "description": "ORCID number of a contributor",
   "type": "String",
   "format": "9999-9999-9999-9999",
   "mandatory": false
 },
 {
   "field": "license",
   "level": 0,
   "parent": "",
   "description": "Software license for the code in this module",
   "type": "String",
   "format": "valid SPDX identifier (second column at https://spdx.org/licenses)",
   "mandatory": false
 },
 {
   "field": "lastUpdateDate",
   "level": 0,
   "parent": "",
   "description": "Date of the last update submitted",
   "type": "Date",
   "format": "YYYY-MM-DD",
   "mandatory": true
 },
 {
   "field": "description",
   "level": 0,
   "parent": "",
   "description": "Description of what the module does. It should expand the information already given in the name/title.",
   "type": "String",
   "format": "free text",
   "mandatory": true
 },
 {
   "field": "relatedModules",
   "level": 0,
   "parent": "",
   "description": "List of modules this one is related to (similar, depending on, ...)",
   "type": "Array",
   "format": "a valid module id as defined above",
   "mandatory": false
 },
 {
   "field": "references",
   "level": 0,
   "parent": "",
   "description": "Literature references",
   "type": "",
   "format": "",
   "mandatory": false
 },
 {
   "field": "moduleReferences",
   "level": 1,
   "parent": "references",
   "description": "References that describe and explain the module, any of its parts, or its original use in a model. This includes public repositories holding models that include the module.",
   "type": "Array",
   "format": "a valid citation key from the submission BIBTEX file (.bib)",
   "mandatory": false
 },
 {
   "field": "useExampleReferences",
   "level": 1,
   "parent": "references",
   "description": "References citing, describing, or using the module, after it has been published in the NASSA library.",
   "type": "Array",
   "format": "a valid citation key from the submission BIBTEX file (.bib)",
   "mandatory": false
 },
 {
   "field": "domainKeywords",
   "level": 0,
   "parent": "",
   "description": "Domain-related keywords",
   "type": "",
   "format": "",
   "mandatory": false
 },
 {
   "field": "subjects",
   "level": 1,
   "parent": "domainKeywords",
   "description": "Subject keyword(s). Example/recommendation: https://ehrafworldcultures.yale.edu/ehrafe/majorSubjects.do",
   "type": "Array",
   "format": "",
   "mandatory": false
 },
 {
   "field": "regions",
   "level": 1,
   "parent": "domainKeywords",
   "description": "Region keyword(s). Example/recommendation: http://www.geonames.org/",
   "type": "Array",
   "format": "",
   "mandatory": false
 },
 {
   "field": "periods",
   "level": 1,
   "parent": "domainKeywords",
   "description": "Period keyword(s). Example/recommendation: https://perio.do/en/",
   "type": "Array",
   "format": "",
   "mandatory": false
 },
 {
   "field": "modellingKeywords",
   "level": 0,
   "parent": "",
   "description": "Modelling-related keyword(s). Using NASSA schema specifications.",
   "type": "Array",
   "format": "",
   "mandatory": true
 },
 {
   "field": "programmingKeywords",
   "level": 0,
   "parent": "",
   "description": "Programming-related keyword(s). Using NASSA schema specifications.",
   "type": "Array",
   "format": "",
   "mandatory": true
 },
 {
   "field": "implementations",
   "level": 0,
   "parent": "",
   "description": "List of implementations in different programming languages",
   "type": "",
   "format": "",
   "mandatory": true
 },
 {
   "field": "language",
   "level": 1,
   "parent": "implementations",
   "description": "Programming language",
   "type": "String",
   "format": "Options: 'C#', 'Java', 'Julia', 'NetLogo', 'Processing', 'Python', 'R', 'Ruby'.",
   "mandatory": true
 },
 {
   "field": "softwareDependencies",
   "level": 1,
   "parent": "implementations",
   "description": "Listing any software (libraries, packages, etc), specifying the release version, on which the module implementation relies to properly function.",
   "type": "Array",
   "format": "free text",
   "mandatory": true
 },
 {
   "field": "docsDir",
   "level": 0,
   "parent": "",
   "description": "Relative path to the directory containing general module documentation.",
   "type": "String",
   "format": "path",
   "mandatory": false
 },
 {
   "field": "inputs",
   "level": 0,
   "parent": "",
   "description": "List of inputs required by the module. Create entries for each of the variables that can or should be given/set externally, so that the module can work.",
   "type": "",
   "format": "",
   "mandatory": false
 },
 {
   "field": "name",
   "level": 1,
   "parent": "inputs",
   "description": "Parameter/variable/file name in the module.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "type",
   "level": 1,
   "parent": "inputs",
   "description": "Parameter/variable/file type. Use the programming language specific type.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "unit",
   "level": 1,
   "parent": "inputs",
   "description": "Parameter/variable unit of measurement, if applicable.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "default",
   "level": 1,
   "parent": "inputs",
   "description": "Parameter/variable default value",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "description",
   "level": 1,
   "parent": "inputs",
   "description": "Parameter/variable/file description. Meaning, data structure, or any other relevant information for the procurement and preparation of the input.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "outputs",
   "level": 0,
   "parent": "",
   "description": "List of outputs generated by the module. Create entries for each of the variables that are suggested as outputs. Ideally, the list should also include any module variable that can be read externally and is the product of module mechanisms (i.e., not equal to the inputs).",
   "type": "",
   "format": "",
   "mandatory": false
 },
 {
   "field": "name",
   "level": 1,
   "parent": "outputs",
   "description": "Variable/object name in the module.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "type",
   "level": 1,
   "parent": "outputs",
   "description": "Variable/object type. Use the programming language specific type.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "unit",
   "level": 1,
   "parent": "outputs",
   "description": "Variable/object unit of measurement, if applicable.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 },
 {
   "field": "description",
   "level": 1,
   "parent": "outputs",
   "description": "Variable/object description. Meaning, data structure, or any other relevant information for data analysis and interpretation or the use of the output as input in another module.",
   "type": "String",
   "format": "free text",
   "mandatory": false
 }
]