credit_metadata
Schema for KBase resource credit metadata. This version brings the schema into closer alignment with the commonmeta citation schema, https://commonmeta.org.
URI: https://github.com/kbase/credit_engine/schema/kbase/linkml
Name: credit_metadata
Classes
| Class | Description |
|---|---|
| Contributor | Represents a contributor to the resource. |
Contributors must have a 'contributor_type', either 'Person' or 'Organization', and one of the 'name' fields: either 'given_name' and 'family_name' (for a person), or 'name' (for an organization or a person).
The 'contributor_role' field takes values from the DataCite and CRediT contributor roles vocabularies. For more information on these resources and choosing appropriate roles, please see the following links:
DataCite contributor roles: https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#7a-contributortype
CRediT contributor role taxonomy: https://credit.niso.org | | CreditMetadata | Represents the credit metadata associated with a workspace object.
In the following documentation, 'Resource' is used to refer to the workspace object that the CM pertains to.
The 'resource_type' field should be filled using values from the DataCite resourceTypeGeneral field:
https://support.datacite.org/docs/datacite-metadata-schema-v44-mandatory-properties#10a-resourcetypegeneral
Currently the KBase workspace only supports credit metadata for objects of type 'dataset'; anything else will return an error.
The license may be supplied either as an URL pointing to licensing information for the resource, or using an SPDX license identifier from the list maintained at https://spdx.org/licenses/.
Required fields are: - identifier - resource_type - versioning information: if the resource does not have an explicit version number, one or more dates should be supplied: ideally the date of resource publication and the last update (if applicable). - contributors (one or more required) - titles (one or more required)
The resource_type field is required, but as there is currently only a single valid value, 'dataset', it is automatically populated if no value is supplied. | | CreditMetadataEntry | Container for an instance of credit metadata; includes the credit metadata itself and metadata for the credit metadata, including the schema version used, who submitted it, and the date of submission. When the credit metadata for a resource is added or updated, a new CreditMetadataEntry is created to store the information. | | Description | Textual information about the resource being represented. | | EventDate | Represents an event in the lifecycle of a resource and the date it occurred on.
See https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#8-date for more information on the events. | | FundingReference | Represents a funding source for a resource, including the funding body and the grant awarded.
The 'funder_name' field is required; all others are optional.
Recommended resources for organization identifiers include: - Research Organization Registry, http://ror.org - International Standard Name Identifier, https://isni.org - Crossref Funder Registry, https://www.crossref.org/services/funder-registry/ (to be subsumed into ROR)
Some organizations may have a digital object identifier (DOI). | | License | License information for the resource. | | Organization | Represents an organization.
Recommended resources for organization identifiers and canonical organization names include: - Research Organization Registry, http://ror.org - International Standard Name Identifier, https://isni.org - Crossref Funder Registry, https://www.crossref.org/services/funder-registry/
For example, the US DOE would be entered as: organization_name: United States Department of Energy organization_id: ROR:01bj3aw27 | | PermanentID | Represents a persistent unique identifier for an entity, with an optional relationship to some other entity.
The 'id' field and 'relationship_type' fields are required.
The values in the 'relationship_type' field come from controlled vocabularies maintained by DataCite and Crossref. See the documentation links below for more details.
DataCite relation types: https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#12b-relationtype
Crossref relation types: https://www.crossref.org/documentation/schema-library/markup-guide-metadata-segments/relationships/ | | Title | Represents the title or name of a resource, the type of that title, and the language used (if appropriate).
The 'title' field is required; 'title_type' is only necessary if the text is not the primary title. |
Slots
| Slot | Description |
|---|---|
| affiliations | List of organizations with which the contributor is affiliated |
| comment | List of strings of freeform text providing extra information about this credi... |
| content_url | The URL of the content of the resource |
| contributor_id | Persistent unique identifier for the contributor; this might be an ORCID for ... |
| contributor_roles | List of roles played by the contributor when working on the resource |
| contributor_type | Must be either 'Person' or 'Organization' |
| contributors | A list of people and/or organizations who contributed to the resource |
| credit_metadata | The credit metadata itself |
| credit_metadata_schema_version | The version of the credit metadata schema used |
| credit_metadata_source | A list of CURIEs, URIs, or free text entries denoting the source of the credi... |
| date | The date associated with the event |
| dates | A list of relevant lifecycle events for the resource |
| description | Description of that entity |
| description_text | The text content of the informational element |
| description_type | The type of text being represented |
| descriptions | A brief description or abstract for the resource being represented |
| event | The nature of the resource-related event that occurred on that date |
| family_name | The family name(s) of the contributor |
| funder | The funder for the grant or award |
| funding | Funding sources for the resource |
| given_name | The given name(s) of the contributor |
| grant_id | Code for the grant, assigned by the funder |
| grant_title | Title for the grant |
| grant_url | URL for the grant |
| id | String representing the license, from the SPDX license identifiers at https:/... |
| identifier | Resolvable persistent unique identifier for the resource |
| language | The language in which the description is written, using the appropriate IETF ... |
| license | Usage license for the resource |
| name | Contributor name |
| organization_id | Persistent unique identifier for the organization in the format <database nam... |
| organization_name | Common name of the organization; use the name recommended by ROR if possible |
| publisher | The publisher of the resource |
| related_identifiers | Other resolvable persistent unique IDs related to the resource |
| relationship_type | The relationship between the ID and some other entity |
| resource_type | The broad type of the source data for this workspace object |
| saved_by | KBase workspace ID of the user who added this entry |
| timestamp | Unix timestamp for the addition of this set of credit metadata |
| title | A string used as a title for a resource |
| title_type | A descriptor for the title for cases where the contents of the 'title' field ... |
| titles | One or more titles for the resource |
| url | The URL of the resource |
| version | The version of the resource |
Enumerations
| Enumeration | Description |
|---|---|
| ContributorRole | The type of contribution made by a contributor |
| ContributorType | The type of contributor being represented |
| DescriptionType | The type of text being represented |
| EventType | The type of date being represented |
| RelationshipType | The relationship between two entities |
| ResourceType | The type of resource being represented |
| TitleType | The type of title being represented |
Types
| Type | Description |
|---|---|
| Boolean | A binary (true or false) value |
| Curie | a compact URI |
| Date | a date (year, month and day) in an idealized calendar |
| DateOrDatetime | Either a date or a datetime |
| Datetime | The combination of a date and time |
| Decimal | A real number with arbitrary precision that conforms to the xsd:decimal speci... |
| Double | A real number that conforms to the xsd:double specification |
| Float | A real number that conforms to the xsd:float specification |
| Integer | An integer |
| Ncname | Prefix part of CURIE |
| Nodeidentifier | A URI, CURIE or BNODE that represents a node in a model |
| Objectidentifier | A URI or CURIE that represents an object in the model |
| String | A character string |
| Time | A time object represents a (local) time of day, independent of any particular... |
| Uri | a complete URI |
| Uriorcurie | a URI or a CURIE |
Subsets
| Subset | Description |
|---|---|