orcid_educations: Get education information for a person

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

Description

Get education information for a person

Usage

orcid_educations(
  orcid,
  put_code = NULL,
  format = "application/json",
  summary = FALSE,
  ...
)

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
summary	(logical) get education summary for a put code. Default: FALSE
...	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: 
# all education data
res <- orcid_educations(orcid = "0000-0002-1642-628X")
res$`0000-0002-1642-628X`
names(res$`0000-0002-1642-628X`)
res$`0000-0002-1642-628X`$`education-summary`

# individual education records
orcid_educations(orcid = "0000-0002-1642-628X", 148494)

# education summary information
orcid_educations(orcid = "0000-0002-1642-628X", 148494, summary = TRUE)

## End(Not run)

rorcid documentation built on Jan. 21, 2021, 1:06 a.m.