diff --git a/DESCRIPTION b/DESCRIPTION index 621a700..c6f91f8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,7 +5,7 @@ Description: Client for various 'CrossRef' 'APIs', including 'metadata' search (including 'bibtex', 'citeproc-json', 'rdf-xml', etc.), convert 'DOIs' to 'PMIDs', and 'vice versa', get citations for 'DOIs', and get links to full text of articles when available. -Version: 0.8.4.9100 +Version: 0.8.4.9310 License: MIT + file LICENSE Authors@R: c( person("Scott", "Chamberlain", role = c("aut", "cre"), diff --git a/R/rcrossref-package.R b/R/rcrossref-package.R index 76b8a4e..15c4236 100644 --- a/R/rcrossref-package.R +++ b/R/rcrossref-package.R @@ -33,6 +33,27 @@ #' be in effect. If you're curious pass in `verbose = TRUE` to #' your function call, and you'll get headers that will display these rate #' limits. +#' +#' **Be nice and share your email with Crossref** +#' +#' The Crossref team encourage requests with appropriate contact information +#' and will forward you to a dedicated API cluster for improved performance when +#' you share your email address with them. +#' +#' +#' To pass your email address to Crossref via this client, simply store it +#' as environment variable in `.Renviron` like this: +#' +#' 1. Open file: +#' `file.edit("~/.Renviron")` +#' +#' 2. Add email address to be shared with Crossref +#' `crossref_email = name@example.com` +#' +#' 3. Save the file and restart your R session +#' +#' Don't wanna share your email any longer? Simply delete it from +#' `~/.Renviron` #' #' @section Text mining: #' All Crossref specific text mining functions are now deprecated, and @@ -66,26 +87,6 @@ #' citations will be added to a file called `crossref.bib`. New citations #' will be appended to that file. Addin authored by Hao Zhu #' -#' -#' @section Be nice and share your email with Crossref: -#' The Crossref team encourage requests with appropriate contact information -#' and will forward you to a dedicated API cluster for improved performance when -#' you share your email address with them. -#' -#' -#' To pass your email address to Crossref via this client, simply store it -#' as environment variable in `.Renviron` like this: -#' -#' 1. Open file: -#' `file.edit("~/.Renviron")` -#' -#' 2. Add email address to be shared with Crossref -#' `crossref_email = name@example.com` -#' -#' 3. Save the file and restart your R session -#' -#' Don't wanna share your email any longer? Simply delete it from -#' `~/.Renviron` #' #' @importFrom methods as #' @importFrom utils modifyList packageVersion diff --git a/man-roxygen/args.R b/man-roxygen/args.R index 06402a1..22ab34f 100644 --- a/man-roxygen/args.R +++ b/man-roxygen/args.R @@ -14,3 +14,6 @@ #' @param order (character) Sort order, one of 'asc' or 'desc' #' @param select (character) One or more field to return (only those fields #' are returned) +#' +#' @note See the "Rate limiting" seciton in [rcrossref] to get +#' into the "fast lane" diff --git a/man/cr_funders.Rd b/man/cr_funders.Rd index 4b87908..e5c1997 100644 --- a/man/cr_funders.Rd +++ b/man/cr_funders.Rd @@ -113,6 +113,10 @@ BEWARE: The API will only work for CrossRef DOIs. This function name changing to \code{cr_funders} in the next version - both work for now } +\note{ +See the "Rate limiting" seciton in \link{rcrossref} to get +into the "fast lane" +} \section{NOTE}{ Funders without IDs don't show up on the /funders route, and in this diff --git a/man/cr_journals.Rd b/man/cr_journals.Rd index fcbde5d..03c0326 100644 --- a/man/cr_journals.Rd +++ b/man/cr_journals.Rd @@ -114,6 +114,10 @@ BEWARE: The API will only work for CrossRef DOIs. Note that some parameters are ignored unless \code{works=TRUE}: sample, sort, order, filter } +\note{ +See the "Rate limiting" seciton in \link{rcrossref} to get +into the "fast lane" +} \section{Explanation of some data fields}{ \itemize{ diff --git a/man/cr_members.Rd b/man/cr_members.Rd index 3e6b19d..8cdc6ca 100644 --- a/man/cr_members.Rd +++ b/man/cr_members.Rd @@ -112,6 +112,10 @@ Search CrossRef members \details{ BEWARE: The API will only work for CrossRef DOIs. } +\note{ +See the "Rate limiting" seciton in \link{rcrossref} to get +into the "fast lane" +} \examples{ \dontrun{ cr_members(member_ids=98) diff --git a/man/cr_prefixes.Rd b/man/cr_prefixes.Rd index b40641c..0f5f15e 100644 --- a/man/cr_prefixes.Rd +++ b/man/cr_prefixes.Rd @@ -127,6 +127,10 @@ may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used. } +\note{ +See the "Rate limiting" seciton in \link{rcrossref} to get +into the "fast lane" +} \examples{ \dontrun{ cr_prefixes(prefixes="10.1016") diff --git a/man/cr_types.Rd b/man/cr_types.Rd index 0fe8a02..5d01d93 100644 --- a/man/cr_types.Rd +++ b/man/cr_types.Rd @@ -110,6 +110,10 @@ Search CrossRef types \details{ BEWARE: The API will only work for CrossRef DOIs. } +\note{ +See the "Rate limiting" seciton in \link{rcrossref} to get +into the "fast lane" +} \examples{ \dontrun{ cr_types() diff --git a/man/cr_works.Rd b/man/cr_works.Rd index 3b95b47..78a7d44 100644 --- a/man/cr_works.Rd +++ b/man/cr_works.Rd @@ -107,6 +107,10 @@ list \code{TRUE}. Default: \code{FALSE}} \description{ Search CrossRef works (articles) } +\note{ +See the "Rate limiting" seciton in \link{rcrossref} to get +into the "fast lane" +} \section{Beware}{ The API will only work for CrossRef DOIs. diff --git a/man/rcrossref-package.Rd b/man/rcrossref-package.Rd index db2f058..253e789 100644 --- a/man/rcrossref-package.Rd +++ b/man/rcrossref-package.Rd @@ -48,6 +48,26 @@ The numbers can change so we can't give a rate limit that will always be in effect. If you're curious pass in \code{verbose = TRUE} to your function call, and you'll get headers that will display these rate limits. + +\strong{Be nice and share your email with Crossref} + +The Crossref team encourage requests with appropriate contact information +and will forward you to a dedicated API cluster for improved performance when +you share your email address with them. +\url{https://github.com/CrossRef/rest-api-doc#good-manners--more-reliable-service} + +To pass your email address to Crossref via this client, simply store it +as environment variable in \code{.Renviron} like this: +\enumerate{ +\item Open file: +\code{file.edit("~/.Renviron")} +\item Add email address to be shared with Crossref +\code{crossref_email = name@example.com} +\item Save the file and restart your R session +} + +Don't wanna share your email any longer? Simply delete it from +\code{~/.Renviron} } \section{Text mining}{ @@ -89,25 +109,4 @@ will be appended to that file. Addin authored by Hao Zhu \url{https://github.com/haozhu233} } -\section{Be nice and share your email with Crossref}{ - -The Crossref team encourage requests with appropriate contact information -and will forward you to a dedicated API cluster for improved performance when -you share your email address with them. -\url{https://github.com/CrossRef/rest-api-doc#good-manners--more-reliable-service} - -To pass your email address to Crossref via this client, simply store it -as environment variable in \code{.Renviron} like this: -\enumerate{ -\item Open file: -\code{file.edit("~/.Renviron")} -\item Add email address to be shared with Crossref -\code{crossref_email = name@example.com} -\item Save the file and restart your R session -} - -Don't wanna share your email any longer? Simply delete it from -\code{~/.Renviron} -} - \keyword{package}