orcid_works: Get works for a person

In ropensci/rorcid: Interface to the 'Orcid.org' API

Get works for a person

Description

Get works for a person

Usage

orcid_works(orcid, put_code = NULL, format = "application/json", ...)

Arguments

orcid	(character) Orcid identifier(s), of the form XXXX-XXXX-XXXX-XXXX. required.
put_code	(character/integer) one or more put codes. up to 50. optional
format	(character) Name of the content-type format. One of "application/vnd.orcid+xml; qs=5", "application/orcid+xml; qs=3", "application/xml", "application/vnd.orcid+json; qs=4", "application/orcid+json; qs=2", "application/json" "application/vnd.citationstyles.csl+json". optional
...	Curl options passed on to crul::HttpClient()

Details

This function is vectorized, so you can pass in many ORCID's, and there's an element returned for each ORCID you put in.

Value

A list of results for each Orcid ID passed in, with each element named by the Orcid ID

Examples

## Not run: 
# get all works
res <- orcid_works(orcid = "0000-0002-9341-7985")
res$`0000-0002-9341-7985`
res$`0000-0002-9341-7985`$works
res$`0000-0002-9341-7985`$works$type
str(res$`0000-0002-9341-7985`)

# get individual works
a <- orcid_works(orcid = "0000-0002-9341-7985", put_code = 5011717)
a$`0000-0002-9341-7985`
a$`0000-0002-9341-7985`$works
b <- orcid_works(orcid = "0000-0002-9341-7985", 
   put_code = c(5011717, 15536016))
b$`0000-0002-9341-7985`

# change formats
orcid_works("0000-0002-9341-7985", 5011717, "application/json")
orcid_works("0000-0002-9341-7985", 5011717, "application/xml")
orcid_works("0000-0002-9341-7985", 5011717, 
  "application/vnd.orcid+xml; qs=5")
orcid_works("0000-0002-9341-7985", 5011717, 
  "application/vnd.citationstyles.csl+json")

# get citations
id <- "0000-0001-7678-8656"
x <- orcid_works(id)
wks <- orcid_works(id, put_code = x[[1]]$works$`put-code`)
wks[[1]]$works$`work.citation.citation-value`

## or send many put codes at once, will be split into chunks of 50 each
id <- "0000-0001-6758-5101"
z <- orcid_works(id)
pcodes <- z[[1]]$works$`put-code`
length(pcodes)
res <- orcid_works(orcid = id, put_code = pcodes)
head(res$`0000-0001-6758-5101`$works)

## End(Not run)

ropensci/rorcid documentation built on Sept. 12, 2022, 2:09 p.m.