Note that SHERPARoMEO will not return more than 50 journals in a single query. The function will warn you if you are in this case.

rr_journal_name(name, qtype = c("exact", "contains", "starts"), key = NULL)

Arguments

name

[character(1+)]
one or several strings to match the titles of the journals

qtype

[character(1)]
in: * "exact" full title must be exactly to provided name, * "contains" the provided name must appear anywhere in the title of the journal, * "starts" the provided name must appear at the start of title of the journal.

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:

  • title [character(1)]
    the name of the journal

  • provided_issn [character(1)]
    the ISSN you provided in your query (might differ from the ISSN returned by the API)

  • issn [character(1)]
    the ISSN of the journal

  • romeocolour [character(1)]
    the SHERPA/RoMEO colour of the journal

  • 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)

  • pre_embargo [character(1)]
    if applicable the embargo period before the author(s) can archive the preprint

  • post_embargo [character(1)]
    if applicable the embargo period before the author(s) can archive the postprint, if value is "after media", it means that the post-print can be archived after media embargo has passed

  • pdf_embargo [character(1)]
    if applicable the embargo period before the author(s) can archive the publisher's version, if value is "after media", it means that the publisher's version can be archived after media embargo has passed

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_journal_name(name = "Journal of Geology")
#> Error: The API endpoint could not be reached. Please try again later.
rr_journal_name(name = "Biogeography", qtype = "contains")
#> Error: The API endpoint could not be reached. Please try again later.
# You can also query multiple journals with exact titles in a single call rr_journal_name(name = c("Journal of Biogeography", "PLoS ONE"), qtype = "exact")
#> Error: The API endpoint could not be reached. Please try again later.
# }