parse_journal: Parse API answer

View source: R/parse_journal.R

parse_journalR Documentation

Parse API answer

Description

Returns data.frame from parsed xml API answer.

Usage

parse_journal(xml_source, outcome, hits, type = c("find", "name"), key = NULL)

Arguments

type

[character(1) in c("find", "name")]
If type = "find" returns only title and issn columns if type = "name" returns full data.frame as specified in Returns sections.

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


Rekyt/rromeo documentation built on June 2, 2022, 1:32 p.m.