Use SHERPA/RoMEO API to retrieve a specific publisher policies on manuscript archival based on matching the name of the publishers.

rr_publisher_name(name, qtype = c("all", "any", "exact"), key = NULL)

Arguments

name

[character(1+)]
One or a vector of query string(s) to search publisher name

qtype

[character(1)]
in c("all", "any", "exact") define the type of matching:

  • all means that all strings in name must appear in any order or location

  • any means that at least one of the strings in name must appear

  • exact means that the name string must appear in the publisher's name or its alias.

key

[character(1)]
a character string containing the API key or NULL (see Details section on how to specify it)

Value

Returns a data frame with the following columns:

  • romeoid [integer(1)]
    the internal index of the publisher in the SHERPA/RoMEO database

  • publisher [character(1)]
    the name of the publisher

  • alias [character(1)]
    if applicable an alternative name of the publisher or the name of the specific publishing branch

  • romeocolour [character(1)]
    a colour assigned by the database that reflects the default policies of the publisher

  • preprint [character(1)]
    is the preprint (not reviewed) archivable?

  • postprint [character(1)]
    is the postprint (reviewed but not formatted) archivable?

  • pdf [character(1)]
    is the publisher's version (reviewed and formatted) archivable?

Details

There are several ways to provide your API key. The best way to know about them is to refer to the vignette about "Setting Up Your API key" accessible with the following command: vignette("setting_up_api_key", package = "rromeo"). You can also use rr_auth that will use the provided key to store it as an environmental variable.

Examples

# \donttest{ rr_publisher_name(name = "Optical Society", qtype = "all")
#> Error: The API endpoint could not be reached. Please try again later.
rr_publisher_name(name = "Swiss Chemistry", qtype = "any")
#> Error: The API endpoint could not be reached. Please try again later.
rr_publisher_name(name = "Swiss Chemistry", qtype = "exact")
#> Error: The API endpoint could not be reached. Please try again later.
# }