id: https://concepts.datalad.org/s/demo-research-information/unreleased name: demo-research-information-schema version: UNRELEASED status: eunal:concept-status/DRAFT title: Data model for capturing information on research (progress) description: | This schema is using the FLAT approach (Flexbile Low-complexity Annotation Technique) and is geared toward metadata entry and submission for pooling information across consortium sites and partners. It is to be taken as a demonstrator rather than a schema building block. Key features of this schema: - adds a PROV interface to a select set of concepts where provenance information shall be recorded. Not all classes receive a PROV interface, because some are just used as classifiers or tags. This limits the expressiveness of the schema, but also its complexity. For example, it is an active decision to *not* be interested in the provenance of a `Convention` or a `Rule`, but to only represent them as facts about the world. More information may be available on the schema's [about page](about). The schema definition is available as - [JSON-LD context](../unreleased.context.jsonld) - [LinkML YAML](../unreleased.yaml) - [LinkML YAML (static/resolved)](../unreleased.static.yaml) - [OWL TTL](../unreleased.owl.ttl) - [SHACL TTL](../unreleased.shacl.ttl) comments: - ALL CONTENT HERE IS UNRELEASED AND MAY CHANGE ANY TIME license: MIT prefixes: CiTO: http://purl.org/spar/cito/ ISSN: http://identifiers.org/issn/ ODRL: http://www.w3.org/ns/odrl/2/ SCoRO: http://purl.org/spar/scoro/ bibo: http://purl.org/ontology/bibo/ # TODO preliminary definition, pointing to a future resolver datalad: https://pid.datalad.org/datasets/ dash: http://datashapes.org/dash# dcat: http://www.w3.org/ns/dcat# dcterms: http://purl.org/dc/terms/ # TODO preliminary definition, pointing to a future resolver dldi: https://pid.datalad.org/distributions/ dlschemas: https://concepts.datalad.org/s/ dlthings: https://concepts.datalad.org/s/things/v2/ dlvocab: https://concepts.datalad.org/vocab/ doi: https://doi.org/ eunal: http://publications.europa.eu/resource/authority/ ex: http://example.org/ fabio: http://purl.org/spar/fabio/ foaf: http://xmlns.com/foaf/0.1/ FRAPO: http://purl.org/cerif/frapo/ geodata: http://sws.geonames.org/ isil: https://w3id.org/isil/ linkml: https://w3id.org/linkml/ marcrel: http://id.loc.gov/vocabulary/relators/ nfo: http://www.semanticdesktop.org/ontologies/2007/03/22/nfo# obo: http://purl.obolibrary.org/obo/ orcid: https://orcid.org/ owl: http://www.w3.org/2002/07/owl# pav: http://purl.org/pav/ prov: http://www.w3.org/ns/prov# rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns# rdfs: http://www.w3.org/2000/01/rdf-schema# ror: https://ror.org/ rrid: "https://scicrunch.org/resolver/RRID:" schema: http://schema.org/ sh: http://www.w3.org/ns/shacl# shaclvue: https://concepts.datalad.org/ns/shaclvue/ sio: http://semanticscience.org/resource/ skos: http://www.w3.org/2004/02/skos/core# spdx: http://spdx.org/rdf/terms# spdxlic: https://spdx.org/licenses/ vcard: http://www.w3.org/2006/vcard/ns# xsd: http://www.w3.org/2001/XMLSchema# xyzri: https://concepts.datalad.org/s/demo-research-information/unreleased/ xyzrins: https://concepts.datalad.org/s/demo-research-information/ns/ default_prefix: xyzri emit_prefixes: - dldi - dlthings - rdf - rdfs - skos - xsd # a bunch more that are not needed for the structural aspects # of the schema, but for records using the schema - ISSN - bibo - datalad - dcterms - dldi - doi - geodata - obo - orcid - ror - rrid - schema - shaclvue - sio - xyzrins imports: - dlschemas:things-data/v1 - dlschemas:things-files/v1 - dlschemas:things-publications/v1 - dlschemas:things-resources/v1 - dlschemas:things-prov/v1 - dlschemas:things-social/v1 - dlschemas:things-study/v1 - dlschemas:things-rules/v1 slots: application_deadline: title: Application deadline description: >- The date by which an application, for example a job application, a fellowship application or a grant application, has to be submitted if it is to be considered for acceptance or funding. range: W3CISO8601 entity: description: >- An entity is a physical, digital, conceptual, or other kind of thing with some fixed aspects; entities may be real or imaginary. range: Thing notes: - This property exists, because in some cases the needs to be an `object` and an additional property that broadly use a range `Thing`. The concrete, initial use case was PROV's Communication. classes: # Classes here are grouped by their nature: # - Things with a provenance interface # - Thing that are "classifiers" (i.e., tags) without a provenance interface # - Non-Things, such as association classes # # otherwise the order is alphanumeric # #Things with a provenance interface # XYZAccolade: is_a: Thing mixins: - EntityMixin title: Accolade description: >- An award, prize, or other honor received in recognition of an achievement. slots: - depiction - title slot_usage: depiction: range: XYZDepiction multivalued: true XYZActivity: is_a: Thing mixins: - ActivityMixin title: Activity description: >- An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. The primary purpose of this metadata type is the descriptions of an entity's provenance (e.g., the identification of the (data) generating activity). slots: - name - part_of slot_usage: part_of: range: XYZActivity multivalued: true broad_mappings: - obo:BFO_0000015 exact_mappings: - prov:Activity XYZCompetition: is_a: Thing mixins: - ActivityMixin title: Competition description: >- A process where multiple agents compete for a resource, such as funding, recognition, or participation. slots: - application_deadline - title slot_usage: kind: range: XYZCompetitionType about: recommended: true title: Topic(s) description: >- Topics related to this competition. range: XYZTopic multivalued: true associated_with: multivalued: true inlined_as_list: true informed_by: range: XYZCommunication multivalued: true inlined_as_list: true ended: title: End description: >- The conclusion of the competition, typically the point of decision-making, or announcement of the winners. influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true narrow_mappings: - FRAPO:FundingProgramme XYZDataItem: is_a: DataItem mixins: - EntityMixin title: Data item description: >- An information content entity that is intended to be a truthful statement about something (modulo, e.g., measurement precision or other systematic errors) and is constructed/acquired by a method which reliably tends to produce (approximately) truthful statements. This is a conceptual entity. A single data item might be available in more than one representation, with differing formats, and serializations. slot_usage: part_of: range: XYZDataset multivalued: true kind: range: XYZDataType XYZDataset: is_a: Dataset title: Dataset mixins: - EntityMixin description: >- A collection of data, published or curated by a single agent. This is a conceptual entity. A single dataset might be available in more than one representation, with differing schematic layouts, formats, and serializations. slots: - depiction - rules slot_usage: depiction: range: XYZDepiction multivalued: true part_of: range: XYZDataset multivalued: true attributed_to: multivalued: true inlined_as_list: true generated_by: multivalued: true inlined_as_list: true derived_from: multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true kind: range: XYZDataType XYZDepiction: is_a: Thing mixins: - EntityMixin title: Depiction description: >- Reference conveyed through pictures. This is a conceptual entity. A single depiction can be available, for example, as a digital images in various (file) formats. slots: # e.g. passport picture, social media card, ... - conforms_to - distributions - rules - title slot_usage: kind: # portrait photo, oil painting, figure, clipart range: XYZDepictionType distributions: range: XYZFile multivalued: true conforms_to: range: Convention multivalued: true comments: - A `Depiction` can be annotated with various common aspects using standard PROV properties. For example, `attribution_to` a photographer, depicted subjects or content via a link through `derived_from`, etc. XYZFile: is_a: File mixins: - EntityMixin title: File description: >- A specific representation of a data item, which may come in the form of an electronic file, or an archive or (also) a directory comprising many files. slots: - conforms_to - rules slot_usage: kind: range: XYZDataType distribution_of: multivalued: true conforms_to: range: Convention multivalued: true generated_by: # one and the same file content can be produced in different ways # (for an extreme case, think "empty file") multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZDocument: is_a: Document mixins: - EntityMixin title: Document description: >- A conceptual entity representing things which a, broadly conceived, "documents. This includes non-textual things like images. A conceputal document is to be distinguished from its physical, or electronic distributions. slots: - rules - distributions slot_usage: kind: title: Document type description: >- The type of this document, e.g. journal article, book, webpage range: XYZBibliographicType part_of: multivalued: true attributed_to: title: Contributors multivalued: true inlined_as_list: true generated_by: multivalued: true inlined_as_list: true derived_from: multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZGrant: is_a: Grant mixins: - EntityMixin title: Grant description: >- A grant, typically financial or otherwise quantifiable, resources. slots: - rules slot_usage: part_of: range: XYZGrant multivalued: true attributed_to: multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZInstrument: is_a: Instrument mixins: - EntityMixin title: Instrument description: >- A thing that enables an agent to perform an action. This is typically a device (e.g., a machine to perform a particular type of measurement), but it can also be a questionnaire that is used to perform a particular kind of assessment. An instrument is typically neither a "reagent", nor an abstract concept. For example, in the case of behavioral experiment with a particular stimulus, only the concrete implementation of the stimulation would be considered an `Instrument`, while the underlying abstract paradigm would be captured as a `Concept`. In the case of a personality test, the `Instrument` is a concrete questionnaire implementation, whereas an underlying personality model factor is to be considered as a `Concept`. The primary purpose of this metadata type is the identification of instruments used in (data) generating activities. slots: - depiction - part_of - rules slot_usage: depiction: range: XYZDepiction multivalued: true kind: title: Instrument type description: >- The type of this instrument, e.g. microscope, software, chainsaw range: XYZInstrumentType part_of: range: XYZInstrument multivalued: true attributed_to: multivalued: true inlined_as_list: true generated_by: multivalued: true inlined_as_list: true alternate_of: range: Thing multivalued: true specialization_of: range: Thing multivalued: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZObjective: is_a: Thing mixins: - EntityMixin title: Objective description: >- A proposition that indicates a planned or anticipated outcome. slots: - title - part_of - depends_on - depiction slot_usage: part_of: range: XYZObjective multivalued: true depends_on: range: XYZObjective multivalued: true depiction: range: XYZDepiction multivalued: true XYZOrganization: is_a: Organization mixins: - AgentMixin title: Organization description: >- A social or legal institution such as a company, a society, or a university. slots: - depiction slot_usage: depiction: range: XYZDepiction multivalued: true part_of: description: >- An organization that the subject is part of. range: XYZOrganization multivalued: true delegated_by: multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZPerson: is_a: Person mixins: - AgentMixin title: Person description: >- Person agents are people, alive, dead, or fictional. slots: - depiction - nickname slot_usage: depiction: range: XYZDepiction multivalued: true delegated_by: multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZProject: is_a: Project title: Project mixins: - ActivityMixin description: >- A collective endeavour of some kind. Typically it is a planned process that is undertaken or attempted to meet some requirement, or to achieve a particular goal. slots: - depiction - part_of slot_usage: depiction: range: XYZDepiction multivalued: true part_of: range: XYZProject multivalued: true associated_with: multivalued: true inlined_as_list: true used: multivalued: true inlined_as_list: true informed_by: range: XYZCommunication multivalued: true inlined_as_list: true started: title: Start ended: title: End influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZPublication: is_a: Publication mixins: - EntityMixin title: Publication description: >- A resource that is the output of a publishing process. slots: - depiction - rules slot_usage: depiction: range: XYZDepiction multivalued: true kind: title: Publication type description: >- The type of this publication, e.g. journal article, book, webpage range: XYZBibliographicType title: description: >- The full title of the publication. required: false description: title: Abstract about: recommended: true title: Topic(s) description: >- Topics covered by this publication. range: XYZTopic multivalued: true attributed_to: multivalued: true inlined_as_list: true title: Contributors generated_by: multivalued: true inlined_as_list: true influenced_by: range: XYZInfluence multivalued: true inlined_as_list: true XYZStudy: is_a: Study mixins: - ActivityMixin title: Study description: >- A planned process that consists of parts: planning, study design execution, documentation and which produce conclusion(s). An investigational endeavour that involves research, enabled by a project. The study relates to the scholarly and practical aspects of conducting the research itself, including the hypotheses being investigated, the data being gathered and analysed, the interpretations being drawn from the data, and the results obtained. In contrast, a project that enables it encompasses the administrative aspects of undertaking the endeavour, including the funding obtained, the people involved, and the management of the project in terms of deadlines and deliverables. slots: - depiction # for stuff like "secret" subject identifiers imposed by DUAs - rules slot_usage: depiction: range: XYZDepiction multivalued: true dimensions: range: XYZConcept factors: range: XYZConcept kind: range: XYZSubjectType XYZSubject: is_a: Subject mixins: - EntityMixin title: Subject description: >- A subject is an entity being investigated in a study. This is a contextual entity. One and the same individual can be different subjects in two different studies. slots: # for stuff like "secret" subject identifiers imposed by DUAs - rules slot_usage: study: range: XYZStudy kind: range: XYZSubjectType # Thing that are "classifiers" (i.e., tags) without a provenance interface # XYZActivityRole: is_a: Thing title: Activity role description: >- A role is the function of an activity with respect to a subject, in the context of an influence. slots: - name broad_mappings: - prov:Role - dcat:Role XYZAgentRole: is_a: Thing title: Agent role description: >- A role is the function of an agent with respect to a subject, in the context of an influence. slots: - name broad_mappings: - prov:Role - dcat:Role XYZBibliographicType: is_a: Thing title: Bibliographic type description: >- Type of a publication or document, e.g., journal article, book, or webpage. XYZCompetitionType: is_a: Thing title: Competition type description: >- Type of a competitions, e.g., call for proposals, horse race, job opening. XYZConcept: is_a: Thing title: Concept description: >- An idea or notion; a unit of thought. In the context of a study, this can be a tag associated with a categorical, independent variable in a study design, an investigative role (e.g., treatments), or an organizational nature (e.g., site labels), or a dependent or outcome variable. `Concept` is related to `Topic`. However a concept is more focused and more clearly delineated in comparison. The primary purpose of this metadata type is the identification of influencing factors or outcome variable related to (scientific) investigations. comments: - The relationship of a focused concept with the broader concept can be described via `broader_mappings`. slots: - title XYZDataType: is_a: Thing title: Data type or format description: >- Type of an data item. slots: - version_of slot_usage: version_of: title: Variant of range: XYZDataType broad_mappings: - dcterms:format narrow_mappings: # Electronic File Format - obo:NCIT_C171252 # Data Type - obo:NCIT_C42645 # Electronic File Content Type - obo:NCIT_C172272 XYZDepictionType: is_a: Thing title: Depiction type description: >- Type of a depiction. XYZEntityRole: is_a: Thing title: Entity role description: >- A role is the function of an entity with respect to a subject, in the context of an influence. slots: - name broad_mappings: - prov:Role - dcat:Role XYZInstrumentType: is_a: Thing title: Instrument type description: >- Type of an instrument. XYZPublicationVenue: is_a: Thing title: Publication venue description: >- "Place" of a publication, e.g., a journal, a website, an edited collection. slots: - title - kind slot_usage: title: description: >- The full title of the publication. required: false kind: title: Publication venue type description: >- The type of this publication venue, e.g. journal article, book, webpage range: XYZBibliographicType XYZQuality: is_a: Thing title: Quality description: >- A quality is an attribute that is intrinsically associated with its bearer (or its parts), but whose presence/absence and observed/measured value may vary. XYZSubjectType: is_a: Thing title: Subject type description: >- Type of a subject (e.g., human study participant, soil sample, cell culture). XYZTopic: is_a: Thing title: Topic description: >- Topic a subject is about, e.g., a particular research question or domain slots: - depiction - part_of slot_usage: depiction: range: XYZDepiction multivalued: true part_of: range: XYZTopic multivalued: true # # Non-Things, such as association classes # ORCID: is_a: Identifier description: >- Unique persistent identifier for a person, provided by the Open Researcher and Contributor ID (ORCID) organisation. slot_usage: notation: description: >- The identifier notation is specified without a URL-prefix, or a `orcid:` prefix. pattern: '^\d{4}-\d{4}-\d{4}-\d{3}[0-9X]{1}$' unique_keys: value: description: The ORCID notation is globally unique within the scope of ORCIDs unique_key_slots: - notation exact_mappings: - obo:IAO_0000708 XYZCommunication: is_a: Communication title: Communication description: >- The exchange of an entity by two activities, one activity using the entity generated by the other. This implies a dependency of the subject activity on the associated activity. slots: - entity slot_usage: entity: description: >- An entity used by the subject, and produced by the associated activity. XYZInfluence: is_a: Influence description: >- Influence is the capacity of an entity, activity, or agent to have an effect on the character, development, or behavior of another by means of usage, start, end, generation, invalidation, communication, derivation, attribution, association, or delegation. slots: - ended - started