cr_prefixes | R Documentation |
Search CrossRef prefixes
cr_prefixes( prefixes, query = NULL, filter = NULL, offset = NULL, limit = NULL, sample = NULL, sort = NULL, order = NULL, facet = FALSE, works = FALSE, cursor = NULL, cursor_max = 5000, .progress = "none", flq = NULL, select = NULL, ... ) cr_prefixes_( prefixes, query = NULL, filter = NULL, offset = NULL, limit = NULL, sample = NULL, sort = NULL, order = NULL, facet = FALSE, works = FALSE, cursor = NULL, cursor_max = 5000, .progress = "none", parse = FALSE, flq = NULL, select = NULL, ... )
prefixes |
(character) Publisher prefixes, one or more in a vector or list. Required. |
query |
Query terms |
filter |
Filter options. See examples for usage examples
and |
offset |
Number of record to start at. Minimum: 1. For
|
limit |
Number of results to return in the query. Not relavant when searching with specific dois. Default: 20. Max: 1000 |
sample |
(integer) Number of random results to return. when you use
the sample parameter, the rows and offset parameters are ignored.
Ignored unless |
sort |
Field to sort on. Acceptable set of fields to sort on:
|
order |
(character) Sort order, one of 'asc' or 'desc' |
facet |
(logical) Include facet results. Boolean or string with
field to facet on. Valid fields are *, affiliation, funder-name,
funder-doi, orcid, container-title, assertion, archive, update-type,
issn, published, source, type-name, publisher-name, license,
category-name, assertion-group. Default: |
works |
(logical) If |
cursor |
(character) Cursor character string to do deep paging.
Default is None. Pass in '*' to start deep paging. Any combination of
query, filters and facets may be used with deep paging cursors.
While the |
cursor_max |
(integer) Max records to retrieve. Only used when
cursor param used. Because deep paging can result in continuous requests
until all are retrieved, use this parameter to set a maximum number of
records. Of course, if there are less records found than this value,
you will get only those found. When cursor pagination is being used
the |
.progress |
Show a |
flq |
field queries. One or more field queries. Acceptable set of field query parameters are:
Note: |
select |
(character) One or more field to return (only those fields are returned) |
... |
Named parameters passed on to |
parse |
(logical) Whether to output json |
BEWARE: The API will only work for CrossRef DOIs.
Note that any one publisher can have more than one DOI. If you want to
search on all DOIs for a publisher, pass in all DOIs, or see
cr_members()
, and pass in the member_ids
parameter.
Notes from CrossRef (quoting them):
The prefix of a CrossRef DOI does NOT indicate who currently owns the DOI.
It only reflects who originally registered the DOI. CrossRef metadata has
an owner_prefix
element that records the current owner of the
CrossRef DOI in question.
CrossRef also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisation, member IDs and the member routes should be used.
When using the cursor, a character string called next-cursor
is
returned from Crossref that we use to do the next request, and so on. We
use a while loop to get number of results up to the value of
cursor_max
. Since we are doing each request for you, you may not
need the next-cursor
string, but if you do want it, you can get
to it by indexing into the result like x$meta$next_cursor
Note that you can pass in curl options when using cursor, via "..."
See the "Rate limiting" seciton in rcrossref to get into the "fast lane"
https://github.com/CrossRef/rest-api-doc
Other crossref:
cr_funders()
,
cr_journals()
,
cr_licenses()
,
cr_members()
,
cr_types()
,
cr_works()
## Not run: cr_prefixes(prefixes="10.1016") cr_prefixes(prefixes="10.1016", works=TRUE) cr_prefixes(prefixes=c('10.1016','10.1371','10.1023','10.4176','10.1093')) cr_prefixes(prefixes=c('10.1016','10.1371'), works=TRUE) cr_prefixes(prefixes="10.1016", works=TRUE, filter=c(has_full_text=TRUE), limit=5) cr_prefixes(prefixes="10.1016", works=TRUE, query='ecology', limit=4) cr_prefixes(prefixes="10.1016", works=TRUE, query='ecology', limit=4) # facets - only avail. when works=TRUE cr_prefixes(prefixes="10.1016", works=TRUE, facet=TRUE) cr_prefixes(prefixes="10.1016", works=TRUE, facet="license:*", limit=0) cr_prefixes(prefixes=c('10.1016','10.1371'), works=TRUE, facet=TRUE, limit=0) # Use the cursor for deep paging cr_prefixes("10.1016", works = TRUE, cursor = "*", cursor_max = 500, limit = 100) cr_prefixes(c('10.1016', '10.1371'), works = TRUE, cursor = "*", cursor_max = 300, limit = 100) ## with optional progress bar cr_prefixes("10.1016", works = TRUE, cursor = "*", cursor_max = 500, limit = 100, .progress = TRUE) # Low level function - does no parsing to data.frame, get json or a list cr_prefixes_("10.1016") cr_prefixes_(c('10.1016', '10.1371')) cr_prefixes_("10.1016", works = TRUE, query = 'ecology', limit = 10) cr_prefixes_("10.1016", works = TRUE, query = 'ecology', parse=TRUE, limit = 10) cr_prefixes_("10.1016", works = TRUE, cursor = "*", cursor_max = 300, limit = 100) cr_prefixes_("10.1016", works = TRUE, cursor = "*", cursor_max = 300, limit = 100, parse = TRUE) # field queries ## query.container-title cr_prefixes("10.1016", works = TRUE, flq = c(`query.container-title` = 'Ecology')) # select only certain fields to return res <- cr_prefixes("10.1016", works = TRUE, select = c('DOI', 'title')) names(res$data) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.