CONP_DATS_fields.json

{
	"fields": [
		{
			"DATS GUI field name": "Title",
			"DATS schema field": "title",
			"Status and Short Description": "**REQUIRED** Name of the dataset. ",
			"DATS GUI help text": " Name of the dataset. The title needs to be short and easily recognizable and searchable. If there is an acronym, please also provide the long name."
		},
		{
			"DATS GUI field name": "Creators",
			"DATS schema field": "creators",
			"Status and Short Description": "**REQUIRED** The person(s) or organization(s) which contributed to the creation of the dataset. ",
			"DATS GUI help text": " The person(s) or organization(s) that contributed to the creation of the dataset. This can be the principal investigator, hospital, university, centre, clinic, etc. The first contact provided will be associated as the main contact for this dataset."
		},
		{
			"DATS GUI field name": "ORCID ID",
			"DATS schema field": "creators - orcid",
			"Status and Short Description": "**REQUIRED IF** the creator is a person (as opposed to an organization)",
			"DATS GUI help text": "ORCID iD (https://orcid.org/XXXX-XXXX-XXXX-XXXX).  You can register for an ORCID [here](https://orcid.org)"
		},
		{
			"DATS GUI field name": "Description",
			"DATS schema field": "description",
			"Status and Short Description": "**REQUIRED** A textual narrative comprised of one or more statements describing the dataset.",
			"DATS GUI help text": " A short paragraph providing an overview of the dataset and the context of data collection. Suggestion of items to include (if applicable) are: main use of the dataset, population studied, study design, sample size, data collected, methods, techniques, apparatus used to generate the data. Ideally, the first sentence of the description should give a good overall description of the dataset."
		},
		{
			"DATS GUI field name": "Data types",
			"DATS schema field": "types",
			"Status and Short Description": "**REQUIRED** Terms to describe the nature of the data. ",
			"DATS GUI help text": " Terms to describe the nature of the data. Data type can be single or multiple. Add a term found in the [Interlex lexicon of biomedical terms](https://neuinfo.org/interlex/dashboard) if possible."
		},
		{
			"DATS GUI field name": "Version",
			"DATS schema field": "version",
			"Status and Short Description": "**REQUIRED** Provide the version number, or the release point of your dataset.",
			"DATS GUI help text": "Provide the version number, or the release point of your dataset. If you do not have an existing versioning convention, we recommend the use of the following versoning convention: 1.0=original dataset; 1.1=minor revisions made to the dataset; 1.2=further minor revisions; 2.0=major/substantive changes to the dataset. For example: minor changes could include corrupted file or link fixes, more description/documentation of the dataset and so on; Major changes would include additional data released (more subjects, more modalities and so on). "
		},
		{
			"DATS GUI field name": "Licenses",
			"DATS schema field": "licenses",
			"Status and Short Description": "**REQUIRED** The use of license name abbreviations is suggested for specifying a license. Please visit [Creative Commons](https://creativecommons.org/share-your-work/) to choose the right licence for you.",
			"DATS GUI help text": " The licences under which this dataset is shared.  A drop-down list of licence options should be provided in the relevant editor interface."
		},
		{
			"DATS GUI field name": "Keywords",
			"DATS schema field": "keywords",
			"Status and Short Description": "**REQUIRED** Tags associated with the dataset, which will help in its discovery. We suggest entering at least 5 keywords, different from the datatype.",
			"DATS GUI help text": "Tags associated with the dataset, which will help in its discovery. These should be well known terms in the research community. "
		},
		{
			"DATS GUI field name": "Formats",
			"DATS schema field": "distributions - format",
			"Status and Short Description": "**REQUIRED** for datasets, **RECOMMENDED** for experiments. The technical format of the dataset distribution. Use the file extension or MIME type when possible. (Definition adapted from DataCite)Primary data files format (*example*: csv, nifti, txt, fasta).",
			"DATS GUI help text": " The technical format of the dataset distribution. Use the file extension or MIME type when possible. An automatic drop-down list of useful formats should be provided in the relevant editor. (Definition adapted from DataCite)."
		},
		{
			"DATS GUI field name": "Size",
			"DATS schema field": "distributions - size",
			"Status and Short Description": "**REQUIRED** Total size of the dataset.",
			"DATS GUI help text": " The quantity of space required on disk (or other medium) for this dataset."
		},
		{
			"DATS GUI field name": "Units",
			"DATS schema field": "distributions - unit",
			"Status and Short Description": "**REQUIRED** Unit in which the size is measured.(*example*: GB)",
			"DATS GUI help text": "Unit in which the size is measured.(KB -> KiloByte, MB -> MegaByte, GB -> GigaByte, TB -> TeraByte and PB -> PetaByte). "
		},
		{
			"DATS GUI field name": "Authorizations",
			"DATS schema field": "distributions - access - authorizations",
			"Status and Short Description": " **REQUIRED** Types of verification that accessing the resource is allowed. Authorization occurs before successful authentication and refers to the process of obtaining approval to use a data set. Ideally specified from a controlled vocabulary or ontology.",
			"DATS GUI help text": "This must be one of \"Public\", \"Registered\" or \"Private\". When this field is absent the value will be treated as \"Public\". \"Public\" = available to anyone; \"Registered\" = available to user authorized by the creator; \"Private\" = available only to the creator."
		},
		{
			"DATS GUI field name": "Number of Files",
			"DATS schema field": "extraProperties - files",
			"Status and Short Description": "**REQUIRED** The number of files in the dataset.",
			"DATS GUI help text": "Total number of files in the dataset. "
		},
		{
			"DATS GUI field name": "Number of Subjects",
			"DATS schema field": "extraProperties - subjects",
			"Status and Short Description": "**REQUIRED** The number of subjects in the dataset.",
			"DATS GUI help text": "Total number of subjects constituting the dataset.  As well as numbers, \"N/A\" is a valid value in cases where this does not apply, eg, expression of human proteins in microbial systems."
		},
		{
			"DATS GUI field name": "CONP Status",
			"DATS schema field": "extraProperties - CONP_status",
			"Status and Short Description": "**REQUIRED** CONP Status.",
			"DATS GUI help text": "The CONP status is used to add the CONP logo or Canadian flag on the left of the dataset and sorting in the data search. Valid values are \"CONP\" = created using funding from the CONP; \"Canadian\" = created in Canada without CONP funding; \"external\" = created outside of Canada."
		},
		{
			"DATS GUI field name": "Privacy",
			"DATS schema field": "privacy",
			"Status and Short Description": "**REQUIRED** The privacy level of the dataset.",
			"DATS GUI help text": "A qualifier to describe the data protection applied to the dataset. This must be one of \"open\", \"registered\", \"controlled\" or \"private\". \"open\" = freely and publicly available (default); \"registered\" = available to bona fide researchers/clinical care professionals only; \"controlled\" = available to qualified researchers approved by a committee after review of their research poposal, also known as managed or restricted access; \"private\" = available only to researchers of the project, also known as closed. Permission to access \"registered\" and \"controlled\" is given by the creator. In the context of an experiment this refers to the privacy levels assigned to the experiment itself rather than any data generated by or included with the experiment."
		},
		{
			"DATS GUI field name": "Origin",
			"DATS schema field": "extraProperties - origin",
			"Status and Short Description": "**REQUIRED** Where the dataset was generated.  **EITHER** extraProperties-origin-institution **OR** extraProperties-origin-consortium **must** be specified.  Both **can** be specified, as in the case of a named collaboration between different labs at the same institution.",
			"DATS GUI help text": " Name of the institution or consortium that generated the dataset. Both an institution and a consortium can be specified, e.g. in the case of a named collaboration between different labs at the same institution. "
		},
		{
			"DATS GUI field name": "Institution",
			"DATS schema field": "extraProperties - origin - institution",
			"Status and Short Description": "**REQUIRED IF** a dataset was generated at a single institution.",
			"DATS GUI help text": " Name of the institution where this dataset was created (if applicable). "
		},
		{
			"DATS GUI field name": "Consortium",
			"DATS schema field": "extraProperties - origin - consortium",
			"Status and Short Description": "**REQUIRED IF** a dataset was generated by a consortium; this is primarily, but not exclusively, for the case of datasets generated at multiple institutions.",
			"DATS GUI help text": "Name of the consortium where this dataset was created (if applicable)."
		},
		{
			"DATS GUI field name": "City",
			"DATS schema field": "extraProperties - origin - city",
			"Status and Short Description": "**REQUIRED IF** a dataset was generated by one institution **OR** by multiple institutions in the same city.",
			"DATS GUI help text": "(Principal) city where this dataset was created."
		},
		{
			"DATS GUI field name": "Province",
			"DATS schema field": "extraProperties - origin - province",
			"Status and Short Description": "**REQUIRED IF** a dataset was generated by one institution **OR** by multiple institutions in the same province (Canada) or state (US).  Not required for datasets generated in countries where this scale of distinction does not apply (eg, UK).",
			"DATS GUI help text": "(Principal) province where this dataset was created."
		},
		{
			"DATS GUI field name": "Country",
			"DATS schema field": "extraProperties - origin - country",
			"Status and Short Description": "**REQUIRED IF** a dataset was generated by one institution **OR** by multiple institutions in the same country.",
			"DATS GUI help text": "(Principal) country where this dataset was created."
		},
		{
			"DATS GUI field name": "Derived From",
			"DATS schema field": "extraProperties - derivedFrom",
			"Status and Short Description": "**REQUIRED IF** the dataset is a derived dataset, the URL of the dataset it is derived from.  The original dataset must also be included as a submodule in the derived dataset.",
			"DATS GUI help text": " Required for derived datasets only. Provide information about the source dataset this dataset has been derived from. "
		},
		{
			"DATS GUI field name": "Parent dataset id",
			"DATS schema field": "extraProperties - parent_dataset_id",
			"Status and Short Description": "**REQUIRED IF** the dataset is a derived dataset, the parent dataset ID (as specified in _conp_dataset/.gitmodules_).",
			"DATS GUI help text": "Identifier (DOI, ARK, or other persistent identifier) of the source dataset used to generate this dataset."
		},
		{
			"DATS GUI field name": "Registration Page",
			"DATS schema field": "extraProperties - registrationPage",
			"Status and Short Description": "**REQUIRED IF** “Privacy” is set to \"registered\", \"controlled\", or \"private\".",
			"DATS GUI help text": " URL of the registration page where users can obtain access credentials or the email of a contact person who manages access. "
		},
		{
			"DATS GUI field name": "Primary Publications",
			"DATS schema field": "primaryPublications",
			"Status and Short Description": "**RECOMMENDED** The primary publication(s) associated with the dataset, usually describing how the dataset was produced.",
			"DATS GUI help text": " The primary publication(s) associated with the dataset, usually describing how the dataset was produced."
		},
		{
			"DATS GUI field name": "Title",
			"DATS schema field": "primaryPublications - title",
			"Status and Short Description": " The name of the publication, usually one sentence or short description of the publication.",
			"DATS GUI help text": "The name of the publication."
		},
		{
			"DATS GUI field name": "Publication Venue",
			"DATS schema field": "primaryPublications - publicationVenue",
			"Status and Short Description": "The name of the publication venue where the document is published (if applicable).",
			"DATS GUI help text": "The name of the publication venue where the document is published (if applicable)."
		},
		{
			"DATS GUI field name": "Authors",
			"DATS schema field": "primaryPublications - authors",
			"Status and Short Description": "Authors of the publication.",
			"DATS GUI help text": "Authors of the publication."
		},
		{
			"DATS GUI field name": "Affiliations",
			"DATS schema field": "primaryPublications - authors - affiliations",
			"Status and Short Description": "Author affiliations.",
			"DATS GUI help text": "Author affiliations."
		},
		{
			"DATS GUI field name": "Date",
			"DATS schema field": "primaryPublications - dates",
			"Status and Short Description": "Relevant dates for the publication. If you provide a date, it must come with a description of the date.",
			"DATS GUI help text": "Relevant dates for the publication. If you provide a date, it must come with a description (i.e. first submission, final approval, date of publication, etc.)."
		},
		{
			"DATS GUI field name": "Identifier",
			"DATS schema field": "primaryPublications - identifier - identifier",
			"Status and Short Description": "**RECOMMENDED** A code uniquely identifying an entity locally to a system or globally.",
			"DATS GUI help text": "A code uniquely identifying the publication locally to a system or globally. Provide a *Document Object Identifier (DOI)* or *Archival Resource Key (ARK)* if you have one."
		},
		{
			"DATS GUI field name": "Identifier Source",
			"DATS schema field": "primaryPublications - identifier - identifierSource",
			"Status and Short Description": "**RECOMMENDED** Information about the organisation/namespace responsible for minting the identifier.",
			"DATS GUI help text": " Information about the organisation/namespace responsible for minting the identifier. It must be provided if the identifier is provided."
		},
		{
			"DATS GUI field name": "Dimensions",
			"DATS schema field": "dimensions",
			"Status and Short Description": "**RECOMMENDED** Different dimensions (granular components i.e.: handedness, weight, number of time event X happened per day,...) making up a dataset. Providing dimensions give more details about the data types.",
			"DATS GUI help text": "Different dimensions (granular components) making up a dataset. Providing dimensions give more details about the data types."
		},
		{
			"DATS GUI field name": "Identifier",
			"DATS schema field": "identifier - identifier",
			"Status and Short Description": "**RECOMMENDED** A code uniquely identifying the dataset locally to a system or globally.",
			"DATS GUI help text": "A code uniquely identifying the dataset locally to a system or globally."
		},
		{
			"DATS GUI field name": "Identifier Source",
			"DATS schema field": "identifier - identifierSource",
			"Status and Short Description": "**RECOMMENDED** Information about the organisation/namespace responsible for minting the identifier.",
			"DATS GUI help text": " Information about the organisation/namespace responsible for minting the identifier. It must be provided if the identifier is provided."
		},
		{
			"DATS GUI field name": "Contact",
			"DATS schema field": "extraProperties - contact",
			"Status and Short Description": "**REQUIRED** Contact information for this dataset.",
			"DATS GUI help text": "Provide contact information (name and email address) of the person responsible for the dataset."
		},
		{
			"DATS GUI field name": "Logo",
			"DATS schema field": "extraProperties - logo",
			"Status and Short Description": "**RECOMMENDED** Link to or provide a logo to display on your resource landing page.",
			"DATS GUI help text": "Link to a URL for the logo or local filename containing the logo."
		},
		{
			"DATS GUI field name": "Landing Page",
			"DATS schema field": "distributions - access - landingPage",
			"Status and Short Description": "**OPTIONAL** Web address (URL) where the original dataset can be found. Default value points to the README.md for the dataset. ",
			"DATS GUI help text": "A URL (Web page) that contains information about the associated dataset (with a link to the dataset) or a direct link to the dataset itself. When none exists yet, please provide the link to the README.md file of the dataset. "
		},
		{
			"DATS GUI field name": "Dates",
			"DATS schema field": "dates",
			"Status and Short Description": "**OPTIONAL** Relevant dates for the dataset. If you provide a date, it must come with a description of the date.",
			"DATS GUI help text": "Relevant dates for the dataset. If you provide a date, it must come with a description of the date (i.e.: first data collection, last data collection, date of first publication, ...). "
		},
		{
			"DATS GUI field name": "Produced By",
			"DATS schema field": "producedBy",
			"Status and Short Description": "**OPTIONAL** Process which generated a given dataset. For example: a pipeline, a software... Note: person's name should go in the Creators fields.",
			"DATS GUI help text": "Process which generated a given dataset.  To be hidden in the case of experiments. "
		},
		{
			"DATS GUI field name": "Is About",
			"DATS schema field": "isAbout",
			"Status and Short Description": "**OPTIONAL** Entities (biological entity, taxonomic information, disease, molecular entity, anatomical part, treatment) associated with this dataset.",
			"DATS GUI help text": "Entities (biological entity, taxonomic information, disease, molecular entity, anatomical part, treatment) associated with this dataset. You must provide a species, and other entities are optional.  Disease state information to be entered here. "
		},
		{
			"DATS GUI field name": "Acknowledges",
			"DATS schema field": "acknowledges",
			"Status and Short Description": "**OPTIONAL** Grant(s) which funded and supported the work reported by the dataset.",
			"DATS GUI help text": " Grant(s) which funded and supported the work reported by the dataset."
		},
		{
			"DATS GUI field name": "Spatial Coverage",
			"DATS schema field": "spatialCoverage",
			"Status and Short Description": "**OPTIONAL** The geographical extension or span covered by the dataset.",
			"DATS GUI help text": "The geographical extension and span (i.e.: city, province, administrative region, ...) covered by the dataset."
		},
		{
			"DATS GUI field name": "Ethical Information",
			"DATS schema field": "REB_statement",
			"Status and Short Description": "**REQUIRED IF** \"Privacy\" is set to \"open\". Ethics claim for the dataset",
			"DATS GUI help text": "In submitting this dataset for inclusion, I declare that (1) participants have provided a valid informed consent to the de-identification and deposit of their data in an open-access portal; or (2) a waiver or other authorization to deposit these de-identified data in an open-access portal was obtained from a research ethics body (REB, IRB, REC, etc.); or (3) local law or a relevant institutional authorization otherwise enables the deposit of these data in an open-access portal; or, (4) these data are not derived from human participants. For experiments option (4) should be the default value, but should need to be actively affirmed by data submitters in the relevant interface."
		},
		{
			"DATS GUI field name": "Ethics Committee Approval Number",
			"DATS schema field": "REB_number",
			"Status and Short Description": "**RECOMMENDED IF** the dataset contains human research data.",
			"DATS GUI help text": "Ethics committee approval number (required for human research data)."
		},
		{
			"DATS GUI field name": "Functions assessed",
			"DATS schema field": "extraProperties - experimentFunctionsAssessed",
			"Status and Short Description": " **REQUIRED** The functions assessed by the experiment. ",
			"DATS GUI help text": " A drop-down list of functions should be available in the editor interface, with the option of adding new functions also available (in the absence of any particularly relevant widely used controlled vocabulary, the intention here is to evolve one of our own from user participation.)"
		},
		{
			"DATS GUI field name": "Stimuli",
			"DATS schema field": "extraProperties - experimentStimuli",
			"Status and Short Description": " **RECOMMENDED** The stimuli used during the experiment.",
			"DATS GUI help text": " The stimuli used during the experiment, if applicable."
		},
		{
			"DATS GUI field name": "Modalities",
			"DATS schema field": "extraProperties - experimentModalities",
			"Status and Short Description": " **REQUIRED** The reactions measured during the experiment.",
			"DATS GUI help text": " The behaviours/reactions measured during the experiment."
		},
		{
			"DATS GUI field name": "Devices",
			"DATS schema field": "extraProperties - experimentDevices",
			"Status and Short Description": " **REQUIRED** Hardware used to run the experiment.",
			"DATS GUI help text": " Hardware used to run the experiment.  This should include the operating system on which the software was run, and any specific instruments needed to measure participant responses."
		},
		{
			"DATS GUI field name": "Software",
			"DATS schema field": "extraProperties - experimentSoftware",
			"Status and Short Description": " **REQUIRED** Software used to run the experiment.",
			"DATS GUI help text": " Software used to run the experiment."
		},
		{
			"DATS GUI field name": "Languages",
			"DATS schema field": "extraProperties - experimentLanguages",
			"Status and Short Description": " **REQUIRED** Languages in which the experiment is available.",
			"DATS GUI help text": " Languages in which the experiment is available."
		},
		{
			"DATS GUI field name": "Validation",
			"DATS schema field": "extraProperties - experimentValidation",
			"Status and Short Description": " **RECOMMENDED** Methods used to validate the results of the experiment.",
			"DATS GUI help text": " Methods used to validate the results of the experiment.  A pull-down list should be provided in the editor interface."
		},
		{
			"DATS GUI field name": "Accessibility",
			"DATS schema field": "extraProperties - experimentAccessibility",
			"Status and Short Description": " **RECOMMENDED** Accessibility features of the experiment.",
			"DATS GUI help text": " Accessibility features of the experiment. A pull-down list should be provided in the editor interface."
		}
	]
}