Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a New Work Type and Pathway for Instruments #1586

Open
ajkiessl opened this issue Sep 12, 2024 · 3 comments · May be fixed by #1595
Open

Create a New Work Type and Pathway for Instruments #1586

ajkiessl opened this issue Sep 12, 2024 · 3 comments · May be fixed by #1595
Assignees

Comments

@ajkiessl
Copy link
Collaborator

Description: Develop a new work type and pathway specifically for instruments.

Requirements:

  1. Create a New Work Type: Instrument: Add a new work type labeled "Instrument" to the system, accommodating the specific metadata requirements for instruments.

  2. Develop a Dedicated Pathway for Instrument Work Type
    Metadata Fields for Instrument Work Type (Mapped to DataCite Schema)

Identifier
The DOI that you are going to create. Add as DataCite property Identifier with identifierType=DOI.

Name
The name by which this instrument is known. Add as DataCite property Title.
Owner
The organization or individual that manages the instrument. Add as DataCite property Contributor with contributorType=HostingInstitution. Consider also to add an identifier for the owner in the nameIdentifier subproperty of Contributor.
Manufacturer
The organization or individual that built the instrument. Add as DataCite property Creator. Consider also to add an identifier for the manufacturer in the nameIdentifier subproperty of Creator.
Model
The name of the model or type of the instrument. As of this writing, the DataCite Schema has no specific property for that. The mapping provided by DataCite suggest to add it as a Description with descriptionType=TechnicalInfo, see note below.
Description
A textual description of the device and its capabilities. Add as DataCite property Description with descriptionType=Abstract.
InstrumentType
A classification of the type of the instrument. As of this writing, the DataCite Schema has no specific property for that. The mapping provided by DataCite suggest to add it as a Description with descriptionType=TechnicalInfo, see note below. An alternative might be to add it as keywords providing such a classification in the Subject property. The latter might be particularly useful if the instrument type is using terms from a controlled vocabulary, as Subject allows to link those terms using the subjectScheme, schemeURI, and valueURI subproperties.
MeasuredVariable
The variables or physical properties that the instrument measures or observes. As of this writing, the DataCite Schema has no specific property for that. The mapping provided by DataCite suggest to add it as a Description with descriptionType=TechnicalInfo, see note below.
Date
Relevant events pertaining to this instrument instance. Add as DataCite property Date. Use dateType=Available to indicate the date that the instrument is or was in operation. Use a single date if the instrument is still in operation, to indicate a start date. Use a date interval to indicate a start and an end date, if the instrument has already been decommissioned.
RelatedIdentifier
This can be used to establish links to related resources. The DataCite Schema has a property with the same name, having very similar subproperties and semantics as the PIDINST Schema.
AlternateIdentifier
To be used if this instrument is also registered elsewhere. Add as DataCite property AlternateIdentifier. Use alternateIdentifierType=SerialNumber for a serial number attributed by the manufacturer. Use alternateIdentifierType=InventoryNumber for an inventory number used by the owner.
Publisher
Set to ScholarSphere
PublicationYear
Mandatory in the DataCite Schema. Set it to the year of issuing the DOI.
ResourceType

FundingReference
Optional. Acknowledgement of external funding that supported the purchase or creation of the instrument.

@Smullz622 Smullz622 self-assigned this Sep 16, 2024
@Smullz622
Copy link
Contributor

Smullz622 commented Sep 16, 2024

@bdezray do we want to allow the following for instruments that are currently only for data & code:

  • request curation
  • display citation
  • request doi minting (pretty sure we already discussed this one but want to confirm)

resolution was to display citation and request doi minting but do not request curation

@Smullz622
Copy link
Contributor

Smullz622 commented Sep 19, 2024

@bdezray the following are the current common fields. Most aren't on this list however. Do they still apply?

    description
    published_date
    subtitle
    keyword
    publisher
    related_url
    subject
    language

Response was that all but subject and language are relevant. However, publisher should be set automatically as Scholarsphere and not be editable. Waiting to hear whether related_url should be it's own field or repurpose as related_identifier or alternative_identifier

@Smullz622 Smullz622 linked a pull request Sep 25, 2024 that will close this issue
@bdezray
Copy link

bdezray commented Oct 25, 2024

Here is the relevant help text for instrument fields:
Work Title: Name of the instrument.
Description: Description of the instrument and its capabilities.
Available Date: Date that the instrument became available for use.
Decommissioned Date: Date that the instrument was decommissioned.
Instrument Type: Include the general classification of the type of instrument.
Model: Include the model of the instrument.
Owner: Organization of individual that manages the instrument.
Manufacturer: Organization or individual that built the instrument.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants