dataset
module in the data model
| Key | Key Description | Valid Values | columnType | Parent | module |
|---|---|---|---|---|---|
| PubmedId | Identifier for publications, articles, or manuscripts associated with the dataset, experiment, or result. These IDs may reference resources such as PubMed, DOI records, or internal publication systems. | STRING_LIST | dataset | ||
| alternateName | An altername name that can be used for search and discovery improvement. | STRING | dataset | ||
| conditionsOfAccess | Additional requirements a user may need outside of Data Use Modifiers. This could include additional registration updating profile information joining a Synapse Team or using specific authentication methods like 2FA or RAS. Omit property if not applicable/unknown. | STRING | dataset | ||
| countryOfOrigin | Origin of individuals from which data were generated. Omit if not applicable/unknown. | STRING | dataset | ||
| creator | Main researchers involved in producing the data in priority order. Usually matches the project PI(s) and data lead(s) responsible for conception and initial content creation. For tools this is the manufacturer or developer of the instrument. Expects properly formatted name of the organization or person (e.g. NF-OSI" or "Robert Allaway") not an id. See https://datacite-metadata-schema.readthedocs.io/en/4.5/properties/creator/." | STRING_LIST | dataset | ||
| croissant_file_s3_object | Link to croissant file for dataset. | STRING | dataset | ||
| dataRestriction | Indicates the restriction level of files/folders. | Controlled, Registered, Open | STRING | dataset | |
| dataUseModifiers | List of data use ontology (DUO) terms that are true for dataset which describes the allowable scope and terms for data use. Most datasets allow "General Research Use" unless otherwise specified. | Clinical Care Use,Collaboration Required,Disease Specific Research,Ethics Approval Required,General Research Use,Genetic Studies Only,Geographical Restriction,Health or Medical or Biomedical Research,Institution Specific Restriction,No General Methods Research,No Restriction,Non-Commercial Use Only,Not-for-Profit Non-Commercial Use Only,Not-for-Profit Organisation Use Only,Population Origins or Ancestry Research Only,Population Origins or Ancestry Research Prohibited,Project Specific Restriction,Publication Moratorium,Publication Required,Research Specific Restrictions,Return to Database or Resource,Time Limit on Use,User Specific Restriction | STRING_LIST | dataset | |
| datasetType | The classification of a dataset based on its role, scope, or purpose within a study. | experimental, publication | STRING | dataset | |
| datePublished | Date the dataset was published or made available on Synapse formatted as YYYY-MM-DD. Maps to schema.org datePublished. | STRING | dataset | ||
| individualCount | Number of unique individuals included in the dataset (whether as individual-level or as aggregate data). Omit if not applicable/unknown. | INTEGER | dataset | ||
| keywords | Typically between 1 to 5 informative terms or phrases that help users find the dataset. | STRING_LIST | dataset | ||
| license | License attached to the data. If indicates UNKNOWN or RESTRICTED-USE. Data may not be used without further contact for terms. | CC BY-NC,CC BY-NC 4.0,CC BY-NC 3.0,CC BY-NC 2.5,CC BY-NC 2.0,CC BY-NC 1.0,CC BY-NC-ND,CC BY-NC-ND 4.0,CC BY-NC-ND 3.0,CC BY-NC-ND 2.5,CC BY-NC-ND 2.0,CC BY-NC-ND 1.0,CC BY-NC-SA,CC BY-NC-SA 4.0,CC BY-NC-SA 3.0,CC BY-NC-SA 2.5,CC BY-NC-SA 2.0,CC BY-NC-SA 1.0,CC BY-ND,CC BY-ND 4.0,CC BY-ND 3.0,CC BY-ND 2.5,CC BY-ND 2.0,CC BY-ND 1.0,CC BY-SA,CC BY-SA 4.0,CC BY-SA 3.0,CC BY-SA 2.5,CC BY-SA 2.0,CC BY-SA 1.0,CC-0,CC0 1.0,CC-BY,CC-BY 4.0,CC-BY 3.0,CC-BY 2.5,CC-BY 2.0,CC-BY 1.0,ODC-BY,ODC-BY 1.0,ODC-ODbL,ODC-ODbL 1.0,ODC-PDDL,ODC-PDDL 1.0,Public Domain,UNKNOWN | STRING_LIST | dataset | |
| subject | Applicable subject term(s) for dataset cataloging; use the Library of Congress Subject Headings (LCSH) scheme. | STRING_LIST | dataset |