Skip to content

Commit

Permalink
add note about fast lane with email to all cr_ methods #173
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Sep 13, 2018
1 parent ed3eec6 commit 29105ae
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 42 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
41 changes: 21 additions & 20 deletions R/rcrossref-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#' <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 `.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
Expand Down Expand Up @@ -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
#' <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.
#' <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 `.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
Expand Down
3 changes: 3 additions & 0 deletions man-roxygen/args.R
Original file line number Diff line number Diff line change
Expand Up @@ -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"
4 changes: 4 additions & 0 deletions man/cr_funders.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/cr_journals.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/cr_members.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/cr_prefixes.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/cr_types.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/cr_works.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 20 additions & 21 deletions man/rcrossref-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 29105ae

Please sign in to comment.