Module raid

Source
Expand description

§Research activity identifier (RAiD) metadata schema

See https://metadata.raid.org/en/v1.6/index.html for official documentation on schema.

Use ACORN to generate JSON schema for RAiD metadata with acorn schema --raid

Structs§

Access
Metadata schema block containing RAiD access information
AccessBuilder
Use builder syntax to set the inputs and finish with build().
AccessIdentifier
Access type identifier
AccessIdentifierBuilder
Use builder syntax to set the inputs and finish with build().
AccessStatement
Metadata schema block containing an explanation for any access type that is not “open”, with the explanation’s associated properties
AccessStatementBuilder
Use builder syntax to set the inputs and finish with build().
AlternateIdentifier
Metadata schema block containing alternative local or global identifiers for the project or activity associated with the RAiD
AlternateIdentifierBuilder
Use builder syntax to set the inputs and finish with build().
AlternateUrl
Link to another website related to the project or activity
AlternateUrlBuilder
Use builder syntax to set the inputs and finish with build().
Contributor
Metadata schema block containing a contributor to a RAiD and their associated properties
ContributorBuilder
Use builder syntax to set the inputs and finish with build().
ContributorPosition
Metadata schema sub-block describing a contributor’s administrative position on a project or activity
ContributorPositionBuilder
Use builder syntax to set the inputs and finish with build().
Date
Start and end dates for the associated metadata
DateBuilder
Use builder syntax to set the inputs and finish with build().
Description
Metadata schema block containing the description of the RAiD and associated properties
DescriptionBuilder
Use builder syntax to set the inputs and finish with build().
DescriptionIdentifier
Metadata schema block declaring the type of description
Identifier
Metadata schema block containing information about the associated type
IdentifierBuilder
Use builder syntax to set the inputs and finish with build().
Language
Metadata schema block declaring the language of the associated text
LanguageBuilder
Use builder syntax to set the inputs and finish with build().
Metadata
Research Activity Identifier (RAiD) Metadata
MetadataBuilder
Use builder syntax to set the inputs and finish with build().
MetadataIdentifier
Metadata schema block containing the RAiD name and associated properties
MetadataIdentifierBuilder
Use builder syntax to set the inputs and finish with build().
Organization
Metadata schema block containing the organization associated with a RAiD and its associated properties
OrganizationRole
Organization role
Owner
Metadata schema sub-block that declares the owner of the RAiD (i.e. the organization requesting the RAiD)
OwnerBuilder
Use builder syntax to set the inputs and finish with build().
RegistrationAgency
Metadata schema block containing the RAiD name and associated properties
RegistrationAgencyBuilder
Use builder syntax to set the inputs and finish with build().
RelatedObject
Metadata schema block containing inputs, outputs, and process documents related to a RAiD plus associated properties
RelatedObjectBuilder
Use builder syntax to set the inputs and finish with build().
RelatedObjectCategory
Related object category information
RelatedObjectCategoryBuilder
Use builder syntax to set the inputs and finish with build().
RelatedObjectIdentifier
Related object identifier
RelatedObjectIdentifierBuilder
Use builder syntax to set the inputs and finish with build().
RelatedRaid
Metadata schema block containing related RAiDs and qualifying the relationship
RelatedRaidBuilder
Use builder syntax to set the inputs and finish with build().
RelatedRaidIdentifier
Related RAiD identifier
RelatedRaidIdentifierBuilder
Use builder syntax to set the inputs and finish with build().
Role
Metadata schema sub-block describing a contributor’s scientific or scholarly role on a project using the CRediT vocabulary
RoleBuilder
Use builder syntax to set the inputs and finish with build().
Title
Metadata schema block containing the title of RAiD and associated properties
TitleBuilder
Use builder syntax to set the inputs and finish with build().
TitleIdentifier
Metadata schema block containing information about the title type

Enums§

AccessType
Allowed values for access types
CreditRole
CRediT role
DescriptionType
Description types
Flag
Flag indicating that a value is affirmative (e.g., for leader or contact)
ObjectCategoryType
Category of input, output, or process document
ObjectType
Type of input, output, or process document
OrganizationRoleType
Organization role identifier
PositionType
Represents a contributor’s administrative position on a project (such as their position on a grant application)
RelatedRaidType
RAiD Relation Type
TitleType
Allowed values for title identifiers