openaire-graph-docs/docs/data-model/entities/result.md

9.2 KiB
Raw Blame History

sidebar_position
1

Result

Results are intended as digital objects, described by metadata, resulting from a scientific process. In this page, we descibe the properties of the Result object.

Moreover, there are the following sub-types of a Result, that inherit all its properties and further extend it:


Properties

id

Type: String

Cardinality: ONE

Main entity identifier, created according to OpenAIRE entity identifier and PID mapping policy.

type

Type: String

Cardinality: ONE

Type of the result. Possible types:

  • publication
  • dataset
  • software
  • other

as declared in the terms from the dnet:result_typologies vocabulary.

originalId

Type: String • Cardinality: MANY

Identifiers of the record at the original sources.

maintitle

Type: String • Cardinality: ONE

A name or title by which a scientific result is known. May be the title of a publication, of a dataset or the name of a piece of software.

subtitle

Type: String • Cardinality: ONE

Explanatory or alternative name by which a scientific result is known.

author

Type: Author • Cardinality: MANY

The main researchers involved in producing the data, or the authors of the publication.

bestaccessright

Type: BestAccessRight • Cardinality: ONE

The most open access right associated to the manifestations of this research results.

contributor

Type: String • Cardinality: MANY

The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.

country

Type: ResultCountry • Cardinality: MANY

Country associated with the result because it is the country of the organisation that manages the institutional repository or national aggregator or CRIS system from which this record was collected Country of affiliations of authors can be found instead in the affiliation rel.

coverage

Type: String • Cardinality: MANY TODO

dateofcollection

Type: String • Cardinality: ONE

When OpenAIRE collected the record the last time. TODO: we should indicate the used date format

description

Type: String • Cardinality: MANY

A brief description of the resource and the context in which the resource was created.

embargoenddate

Type: String • Cardinality: ONE

Date when the embargo ends and this result turns Open Access. TODO: we should indicate the used date format

instance

Type: Instance • Cardinality: MANY

Specific materialization or version of the result. For example, you can have one result with three instances: one is the pre-print, one is the post-print, one is the published version

language

Type: Language • Cardinality: ONE

The alpha-3/ISO 639-2 code of the language. Values controlled by the dnet:languages vocabulary

lastupdatetimestamp

Type: Long • Cardinality: ONE

Timestamp of last update of the record in OpenAIRE.

pid

Type: ResultPid • Cardinality: MANY

Persistent identifiers of the result. See also OpenAIRE entity identifier and PID mapping policy to learn more.

publicationdate

Type: String • Cardinality: ONE

Main date of the research product: typically the publication or issued date. In case of a research result with different versions with different dates, the date of the result is selected as the most frequent well-formatted date. If not available, then the most recent and complete date among those that are well-formatted. For statistics, the year is extracted and the result is counted only among the result of that year. Example: Pre-print date: 2019-02-03, Article date provided by repository: 2020-02, Article date provided by Crossref: 2020, OpenAIRE will set as date 2019-02-03, because its the most recent among the complete and well-formed dates. If then the repository updates the metadata and set a complete date (e.g. 2020-02-12), then this will be the new date for the result because it becomes the most recent most complete date. However, if OpenAIRE then collects the pre-print from another repository with date 2019-02-03, then this will be the “winning date” because it becomes the most frequent well-formatted date.

publisher

Type: String • Cardinality: ONE

The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.

source

Type: String • Cardinality: MANY

A related resource from which the described resource is derived. See definition of Dublin Core field dc:source.

subjects

Type: Subject • Cardinality: MANY

Subject, keyword, classification code, or key phrase describing the resource.


Sub-types

There are the following sub-types of Result. Each inherits all its fields and extends them with the following.

Publication

container

Type: Container • Cardinality: ONE

Container has information about the conference or journal where the result has been presented or published.

Dataset

size

Type: String • Cardinality: ONE

The size of the dataset.

version

Type: String • Cardinality: ONE

The version of the dataset.

geolocation

Type: GeoLocation • Cardinality: MANY

The list of geolocations associated with the dataset.

Software

documentationUrl

Type: String • Cardinality: MANY

The URLs to the software documentation.

codeRepositoryUrl

Type: String • Cardinality: ONE

The URL to the repository holding the source code,

programmingLanguage

Type: String • Cardinality: ONE

The programming language.

Other research product

contactperson

Type: String • Cardinality: MANY

The contact person for this ORP.

contactgroup

Type: String • Cardinality: MANY

The information for the contact group.

tool

Type: String • Cardinality: MANY

Information about tool useful for the interpretation and/or re-use of the research product.


Other component objects

Author

Represents the result author.

Example
{
    "fullname":"Turunen, Heidi",
    "name":"Heidi",
    "surname":"Turunen",
    "rank":1,
    "pid":{
        "id":{
            "scheme":"orcid",
            "value":"0000-0001-7169-1177" 
        },
        "provenance":{
            "provenance":"Harvested",
            "trust":"0.9" 
        }
    }
}

fullname

Type: String • Cardinality: ONE

Author's full name.

name

Type: String • Cardinality: ONE

Author's given name.

surname

Type: String • Cardinality: ONE

Author's family name.

rank

Type: String • Cardinality: ONE

Author's order in the list of authors for the given result.

pid

Type: AuthorPid • Cardinality: ONE

Persistent identifier associated with this author.

AuthorPid

The author's persistent identifier.

Example
{
    "id":{
        "scheme":"orcid",
        "value":"0000-0001-7169-1177" 
    },
    "provenance":{
        "provenance":"Inferred by OpenAIRE",
        "trust":"0.85" 
    }
}

id

Type: AuthorPidSchemaValue • Cardinality: ONE

provenance

Type: Provenance • Cardinality: ONE

AuthorPidSchemaValue

Type used to represent the scheme and value for the author's pid.

Example
{
	"scheme" : "orcid",
	"value" : "0000-1111-2222-3333"
}

schema

Type: String • Cardinality: ONE

The author's pid scheme. OpenAIRE currently supports ORCID.

value

Type: String • Cardinality: ONE

The author's pid value.

BestAccessRight

Container

GeoLocation

ResultCountry

Instance

Language

Provenance

Indicates the process that produced (or provided) the information, and the trust associated to the information.

Example
[
	{
		"provenance":"Harvested",
		"trust":"0.9"
	},
	{
		"provenance":"Inferred by OpenAIRE",
		"trust":"0.875"
	},
	{
		"provenance":"Linked by user",
		"trust":"0.8"
	}
]

provenance

Type: String • Cardinality: ONE

provenance term from the vocabulary dnet:provenanceActions.

trust

Type: String • Cardinality: ONE

Trust, expressed as a number in the range [0-1].

ResultPid

Subject