NAME

doi2rdm

SYNOPSIS

doi2rdm OPTIONS OPTIONS_YAML [crossref|datacite] DOI

DESCRIPTION

doi2rdm is a Caltech Library oriented command line application that takes a DOI, queries the CrossRef or DataCite API then returns a JSON document suitable for import into Invenio RDM. The DOI can be in either their canonical form or URL form (e.g. “10.1021/acsami.7b15651” or “https://doi.org/10.1021/acsami.7b15651”).

If a DOI is retrieve the exit code will be zero. If a DOI is not found the exit code with be ENOENT (2) else another non-zero exit code will be returned depending on the problem.

OPTIONS_YAML

doi2rdm can use an YAML options file to set the behavior of the crosswalk from CrossRef to RDM. This replaces many of the options previously required in prior implementations of this tool. See all the default options setting use the -show-yaml command line options. You can save this to disk, modify it, then use them for migrating content from CrossRef to RDM.

OPTIONS

-help

display help

-license

display license

-version

display version

-diff JSON_FILENAME

compare the JSON_FILENAME contents with record generated from CrossRef or DataCite works record

-show-yaml

This will display the default YAML configuration file. You can save this and customize to suit your needs.

EXAMPLES

Save the default YAML options to a file. You can customize this to match your vocabulary requirements in your RDM deployment.

    doi2rdm -show-yaml >options.yaml

Example generating a JSON document for a single DOI. The resulting text file is called “article.json”. In this example “options.yaml” is the configuration file for setup for your RDM instance. It’ll first check CrossRef then DataCite.

    doi2rdm options.yaml "10.1021/acsami.7b15651" >article.json

Check to see the difference from the saved “article.json” and the current metadata retrieved from CrossRef or DataCite.

    doi2rdm -diff article.json options.yaml "10.1021/acsami.7b15651"

Example getting metadata for an arXiv record from DataCite

    doi2rdm options.yaml "arXiv:2312.07215"