cr_members {rcrossref} | R Documentation |
Search CrossRef members
Description
Search CrossRef members
Usage
cr_members(
member_ids = NULL,
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_members_(
member_ids = NULL,
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,
...
)
Arguments
member_ids |
One or more member ids. See examples. Alternatively, you can query for them using the query parameter. |
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 |
Details
BEWARE: The API will only work for CrossRef DOIs.
Deep paging (using the cursor)
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 "..."
Note
See the "Rate limiting" seciton in rcrossref to get into the "fast lane"
References
https://github.com/CrossRef/rest-api-doc
See Also
Other crossref:
cr_funders()
,
cr_journals()
,
cr_licenses()
,
cr_prefixes()
,
cr_types()
,
cr_works()
Examples
## Not run:
cr_members(member_ids=98)
cr_members(member_ids=340)
cr_members(member_ids=98, works=TRUE)
cr_members(member_ids=c(10,98,45,1,9))
cr_members(member_ids=c(10,98,45,1,9), works=TRUE)
cr_members(query='hindawi')
cr_members(query='ecology')
# facets
cr_members(member_ids=98, works=TRUE, facet=TRUE, limit = 0)
cr_members(member_ids=98, works=TRUE, facet="license:*", limit = 0)
# curl options
cr_members(member_ids=98, verbose = TRUE)
# Use the cursor for deep paging
cr_members(member_ids=98, works = TRUE, cursor = "*",
cursor_max = 500, limit = 100)
cr_members(member_ids=c(10, 98, 45), works = TRUE, cursor = "*",
cursor_max = 200, limit = 100)
## with optional progress bar
cr_members(member_ids=98, works = TRUE, cursor = "*",
cursor_max = 500, limit = 100, .progress = TRUE)
# data not found
# cr_members(query="adfdf")
# cr_members(member_ids=c(323234343434,3434343434), works=TRUE, facet=TRUE)
# cr_members(member_ids=c(323234343434,3434343434,98), works=TRUE,facet=TRUE)
# Low level function - does no parsing to data.frame, get json or a list
cr_members_(query = 'hindawi')
cr_members_(member_ids = 98)
cr_members_(query = 'hindawi', parse=TRUE)
cr_members_(member_ids = 98, works = TRUE, cursor = "*",
cursor_max = 300, limit = 100)
cr_members_(member_ids = 98, works = TRUE, cursor = "*",
cursor_max = 300, limit = 100, parse=TRUE)
# field queries
## query.container-title
cr_members(98, works = TRUE, flq = c(`query.container-title` = 'Ecology'))
# select only certain fields to return
res <- cr_members(98, works = TRUE, select = c('DOI', 'title'))
names(res$data)
## End(Not run)