Class: 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.

__

URI: kbcms:CreditMetadata

classDiagram class CreditMetadata CreditMetadata : comment CreditMetadata : content_url CreditMetadata : contributors CreditMetadata --|> Contributor : contributors CreditMetadata : credit_metadata_source CreditMetadata : dates CreditMetadata --|> EventDate : dates CreditMetadata : descriptions CreditMetadata --|> Description : descriptions CreditMetadata : funding CreditMetadata --|> FundingReference : funding CreditMetadata : identifier CreditMetadata : license CreditMetadata --|> License : license CreditMetadata : publisher CreditMetadata --|> Organization : publisher CreditMetadata : related_identifiers CreditMetadata --|> PermanentID : related_identifiers CreditMetadata : resource_type CreditMetadata --|> ResourceType : resource_type CreditMetadata : titles CreditMetadata --|> Title : titles CreditMetadata : url CreditMetadata : version

Slots

Name	Cardinality and Range	Description	Inheritance
comment	0..* String	List of strings of freeform text providing extra information about this credi...	direct
content_url	0..* Uri	The URL of the content of the resource	direct
contributors	1..* Contributor	A list of people and/or organizations who contributed to the resource	direct
credit_metadata_source	0..* String	A list of CURIEs, URIs, or free text entries denoting the source of the credi...	direct
dates	0..* EventDate	A list of relevant lifecycle events for the resource	direct
descriptions	0..* Description	A brief description or abstract for the resource being represented	direct
funding	0..* FundingReference	Funding sources for the resource	direct
identifier	1..1 Uriorcurie	Resolvable persistent unique identifier for the resource	direct
license	0..1 License	Usage license for the resource	direct
publisher	0..1 Organization	The publisher of the resource	direct
related_identifiers	0..* PermanentID	Other resolvable persistent unique IDs related to the resource	direct
resource_type	1..1 ResourceType	The broad type of the source data for this workspace object	direct
titles	1..* Title	One or more titles for the resource	direct
url	0..1 Uri	The URL of the resource	direct
version	0..1 String	The version of the resource	direct

Usages

used by	used in	type	used
CreditMetadataEntry	credit_metadata	range	CreditMetadata

Identifier and Mapping Information

Schema Source

from schema: https://github.com/kbase/credit_engine/schema/kbase/linkml

Mappings

Mapping Type	Mapped Value
self	kbcms:CreditMetadata
native	kbcms:CreditMetadata

LinkML Source

Direct

name: CreditMetadata
description: '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.

  '
from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
attributes:
  comment:
    name: comment
    description: List of strings of freeform text providing extra information about
      this credit metadata.
    examples:
    - value: This comment adds a lot of extra value!
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    slot_uri: schema:comment
    multivalued: true
    inlined: true
    inlined_as_list: true
  content_url:
    name: content_url
    description: The URL of the content of the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    multivalued: true
    range: uri
    inlined: true
    inlined_as_list: true
  contributors:
    name: contributors
    description: A list of people and/or organizations who contributed to the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    narrow_mappings:
    - DataCite:attributes.contributors
    - DataCite:attributes.creators
    - ORCID:contributors
    - OSTI.ARTICLE:contributors
    - OSTI.ARTICLE:authors
    - JGI:organisms.pi
    rank: 1000
    slot_uri: schema:creator
    multivalued: true
    range: Contributor
    required: true
    inlined: true
    inlined_as_list: true
  credit_metadata_source:
    name: credit_metadata_source
    description: A list of CURIEs, URIs, or free text entries denoting the source
      of the credit metadata.
    examples:
    - value: https://figshare.com/articles/dataset/Blue_Hole_Metagenome-assembled_Genomes/12644081
    - value: DataCite
    - value: DOI:10.13039/100000015
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    multivalued: true
    inlined: true
    inlined_as_list: true
  dates:
    name: dates
    description: A list of relevant lifecycle events for the resource. Note that these
      dates apply only to the resource itself, and not to the creation or update of
      the credit metadata record for the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    close_mappings:
    - DataCite:attributes.published
    - DataCite:attributes.updated
    - DataCite:attributes.dates
    - ORCID:publicationDate
    - OSTI.ARTICLE:publication_date
    - Crossref:message.deposited
    rank: 1000
    multivalued: true
    range: EventDate
    inlined: true
    inlined_as_list: true
  descriptions:
    name: descriptions
    description: A brief description or abstract for the resource being represented.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    slot_uri: schema:description
    multivalued: true
    range: Description
  funding:
    name: funding
    description: Funding sources for the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    close_mappings:
    - DataCite:attributes.funding_references
    - Crossref:Message.project.funding
    - OSTI.ARTICLE:awards
    rank: 1000
    slot_uri: schema:funding
    multivalued: true
    range: FundingReference
    inlined: true
    inlined_as_list: true
  identifier:
    name: identifier
    description: Resolvable persistent unique identifier for the resource. Should
      be in the format <database name>:<identifier within database>.
    examples:
    - value: RefSeq:GCF_004214875.1
    - value: GenBank:CP035949.1
    - value: img.taxon:648028003
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - DataCite:id
    - JGI:organisms.grouped_by
    narrow_mappings:
    - OSTI.ARTICLE:osti_id
    - OSTI.ARTICLE:doi
    - ORCID:doi
    - ORCID:url
    rank: 1000
    slot_uri: schema:identifier
    range: uriorcurie
    required: true
    pattern: ^[a-zA-Z0-9.-_]+:\S
  license:
    name: license
    description: 'Usage license for the resource. Use one of the SPDX license identifiers
      or provide a link to the license text if no SPDX ID is available.


      All data published at KBase is done so under a Creative Commons 0 or Creative
      Commons 4.0 license.

      '
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - biolink:license
    related_mappings:
    - DataCite:attributes.rights_list
    rank: 1000
    slot_uri: schema:license
    range: License
  publisher:
    name: publisher
    description: The publisher of the resource. For a dataset, this is the repository
      where it is stored.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    narrow_mappings:
    - ORCID:url
    - OSTI.ARTICLE:site_url
    rank: 1000
    slot_uri: schema:provider
    range: Organization
  related_identifiers:
    name: related_identifiers
    description: Other resolvable persistent unique IDs related to the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    close_mappings:
    - DataCite:attributes.identifiers
    - DataCite:attributes.related_identifiers
    - DataCite:attributes.alternate_identifiers
    - ORCID:externalIds
    - OSTI.ARTICLE:related_identifiers
    narrow_mappings:
    - ORCID:doi
    - OSTI.ARTICLE:doi
    rank: 1000
    multivalued: true
    range: PermanentID
    inlined: true
    inlined_as_list: true
  resource_type:
    name: resource_type
    description: The broad type of the source data for this workspace object. 'dataset'
      is currently the only valid value for KBase DOIs.
    examples:
    - value: dataset
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - OSTI.ARTICLE:product_type
    - OSTI.ARTICLE:workType
    - DataCite:attributes.types.schema_org
    narrow_mappings:
    - OSTI.ARTICLE:dataset_type
    rank: 1000
    slot_uri: schema:@type
    range: ResourceType
    required: true
  titles:
    name: titles
    description: One or more titles for the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - DataCite:attributes.titles
    - ORCID:title
    - OSTI.ARTICLE:title
    rank: 1000
    multivalued: true
    range: Title
    required: true
    inlined: true
    inlined_as_list: true
  url:
    name: url
    description: The URL of the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    range: uri
  version:
    name: version
    description: The version of the resource. This must be an absolute version, not
      a relative version like 'latest'.
    examples:
    - value: '5'
    - value: 1.2.1
    - value: '20220405'
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - DataCite:attributes.version
    rank: 1000
    slot_uri: schema:version

Induced

name: CreditMetadata
description: '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.

  '
from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
attributes:
  comment:
    name: comment
    description: List of strings of freeform text providing extra information about
      this credit metadata.
    examples:
    - value: This comment adds a lot of extra value!
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    slot_uri: schema:comment
    multivalued: true
    alias: comment
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: string
    inlined: true
    inlined_as_list: true
  content_url:
    name: content_url
    description: The URL of the content of the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    multivalued: true
    alias: content_url
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: uri
    inlined: true
    inlined_as_list: true
  contributors:
    name: contributors
    description: A list of people and/or organizations who contributed to the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    narrow_mappings:
    - DataCite:attributes.contributors
    - DataCite:attributes.creators
    - ORCID:contributors
    - OSTI.ARTICLE:contributors
    - OSTI.ARTICLE:authors
    - JGI:organisms.pi
    rank: 1000
    slot_uri: schema:creator
    multivalued: true
    alias: contributors
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: Contributor
    required: true
    inlined: true
    inlined_as_list: true
  credit_metadata_source:
    name: credit_metadata_source
    description: A list of CURIEs, URIs, or free text entries denoting the source
      of the credit metadata.
    examples:
    - value: https://figshare.com/articles/dataset/Blue_Hole_Metagenome-assembled_Genomes/12644081
    - value: DataCite
    - value: DOI:10.13039/100000015
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    multivalued: true
    alias: credit_metadata_source
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: string
    inlined: true
    inlined_as_list: true
  dates:
    name: dates
    description: A list of relevant lifecycle events for the resource. Note that these
      dates apply only to the resource itself, and not to the creation or update of
      the credit metadata record for the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    close_mappings:
    - DataCite:attributes.published
    - DataCite:attributes.updated
    - DataCite:attributes.dates
    - ORCID:publicationDate
    - OSTI.ARTICLE:publication_date
    - Crossref:message.deposited
    rank: 1000
    multivalued: true
    alias: dates
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: EventDate
    inlined: true
    inlined_as_list: true
  descriptions:
    name: descriptions
    description: A brief description or abstract for the resource being represented.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    slot_uri: schema:description
    multivalued: true
    alias: descriptions
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: Description
  funding:
    name: funding
    description: Funding sources for the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    close_mappings:
    - DataCite:attributes.funding_references
    - Crossref:Message.project.funding
    - OSTI.ARTICLE:awards
    rank: 1000
    slot_uri: schema:funding
    multivalued: true
    alias: funding
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: FundingReference
    inlined: true
    inlined_as_list: true
  identifier:
    name: identifier
    description: Resolvable persistent unique identifier for the resource. Should
      be in the format <database name>:<identifier within database>.
    examples:
    - value: RefSeq:GCF_004214875.1
    - value: GenBank:CP035949.1
    - value: img.taxon:648028003
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - DataCite:id
    - JGI:organisms.grouped_by
    narrow_mappings:
    - OSTI.ARTICLE:osti_id
    - OSTI.ARTICLE:doi
    - ORCID:doi
    - ORCID:url
    rank: 1000
    slot_uri: schema:identifier
    alias: identifier
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: uriorcurie
    required: true
    pattern: ^[a-zA-Z0-9.-_]+:\S
  license:
    name: license
    description: 'Usage license for the resource. Use one of the SPDX license identifiers
      or provide a link to the license text if no SPDX ID is available.


      All data published at KBase is done so under a Creative Commons 0 or Creative
      Commons 4.0 license.

      '
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - biolink:license
    related_mappings:
    - DataCite:attributes.rights_list
    rank: 1000
    slot_uri: schema:license
    alias: license
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: License
  publisher:
    name: publisher
    description: The publisher of the resource. For a dataset, this is the repository
      where it is stored.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    narrow_mappings:
    - ORCID:url
    - OSTI.ARTICLE:site_url
    rank: 1000
    slot_uri: schema:provider
    alias: publisher
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: Organization
  related_identifiers:
    name: related_identifiers
    description: Other resolvable persistent unique IDs related to the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    close_mappings:
    - DataCite:attributes.identifiers
    - DataCite:attributes.related_identifiers
    - DataCite:attributes.alternate_identifiers
    - ORCID:externalIds
    - OSTI.ARTICLE:related_identifiers
    narrow_mappings:
    - ORCID:doi
    - OSTI.ARTICLE:doi
    rank: 1000
    multivalued: true
    alias: related_identifiers
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: PermanentID
    inlined: true
    inlined_as_list: true
  resource_type:
    name: resource_type
    description: The broad type of the source data for this workspace object. 'dataset'
      is currently the only valid value for KBase DOIs.
    examples:
    - value: dataset
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - OSTI.ARTICLE:product_type
    - OSTI.ARTICLE:workType
    - DataCite:attributes.types.schema_org
    narrow_mappings:
    - OSTI.ARTICLE:dataset_type
    rank: 1000
    slot_uri: schema:@type
    alias: resource_type
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: ResourceType
    required: true
  titles:
    name: titles
    description: One or more titles for the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - DataCite:attributes.titles
    - ORCID:title
    - OSTI.ARTICLE:title
    rank: 1000
    multivalued: true
    alias: titles
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: Title
    required: true
    inlined: true
    inlined_as_list: true
  url:
    name: url
    description: The URL of the resource.
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    rank: 1000
    alias: url
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    - License
    range: uri
  version:
    name: version
    description: The version of the resource. This must be an absolute version, not
      a relative version like 'latest'.
    examples:
    - value: '5'
    - value: 1.2.1
    - value: '20220405'
    from_schema: https://github.com/kbase/credit_engine/schema/kbase/linkml
    exact_mappings:
    - DataCite:attributes.version
    rank: 1000
    slot_uri: schema:version
    alias: version
    owner: CreditMetadata
    domain_of:
    - CreditMetadata
    range: string