R/literature_pmid.R

In rif: Client for 'Neuroscience' Information Framework 'APIs'

#' Get articles by PMID
#'
#' @export
#' @param pmid One or more PMID's in a vector or list
#' @param key (character) API key. required either passed in here or save
#' as an env var or R option. see \code{\link{rif}} and \code{\link{Startup}}
#' @param ... Curl options passed on to [crul::HttpClient()]
#' @family literature
#' @examples \dontrun{
#' # get PMIDs for retracted articles
#' (out <- literature_retractions())
#' # then get info on some articles
#' literature_pmid(pmid = out[1])
#' literature_pmid(pmid = out[1:2])
#' literature_pmid(pmid = out[1:10])
#' }

literature_pmid <- function(pmid, key = NULL, ...) {
  args <- stats::setNames(as.list(pmid), rep("pmid", length(pmid)))
  args$key <- key_check(key)
  nif_parse(
    nif_GET("literature/pmid.json", args, ...), FALSE
  )
}