-
Notifications
You must be signed in to change notification settings - Fork 1
/
doi2rdm.1.html
95 lines (93 loc) · 3.75 KB
/
doi2rdm.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<!DOCTYPE html>
<html>
<head>
<title>Institutional Repository Data Management</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="https://caltechlibrary.github.io/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="index.html">README</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="INSTALL.html">INSTALL</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="search.html">Search Docs</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/caltechlibrary/irdmtools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>doi2rdm</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>doi2rdm <a href="#options">OPTIONS</a> <a
href="#options_yaml">OPTIONS_YAML</a> [crossref|datacite] DOI</p>
<h1 id="description">DESCRIPTION</h1>
<p>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”).</p>
<p>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.</p>
<h1 id="options_yaml">OPTIONS_YAML</h1>
<p>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 <code>-show-yaml</code> command line
options. You can save this to disk, modify it, then use them for
migrating content from CrossRef to RDM.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-version</dt>
<dd>
display version
</dd>
<dt>-diff JSON_FILENAME</dt>
<dd>
compare the JSON_FILENAME contents with record generated from CrossRef
or DataCite works record
</dd>
<dt>-show-yaml</dt>
<dd>
This will display the default YAML configuration file. You can save this
and customize to suit your needs.
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Save the default YAML options to a file. You can customize this to
match your vocabulary requirements in your RDM deployment.</p>
<pre><code> doi2rdm -show-yaml >options.yaml</code></pre>
<p>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.</p>
<pre><code> doi2rdm options.yaml "10.1021/acsami.7b15651" >article.json</code></pre>
<p>Check to see the difference from the saved “article.json” and the
current metadata retrieved from CrossRef or DataCite.</p>
<pre><code> doi2rdm -diff article.json options.yaml "10.1021/acsami.7b15651"</code></pre>
<p>Example getting metadata for an arXiv record from DataCite</p>
<pre><code> doi2rdm options.yaml "arXiv:2312.07215"</code></pre>
</section>
<footer>
<span>© 2023 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>