Skip to contents

Identify the open-access status and reuse license of a PMC XML file.

Source: R/rt_open_access.R
rt_oa_pmc.Rd

Detects whether an article is openly licensed and, when it is, the canonical license identifier (for example `CC-BY-4.0`, `CC-BY-NC-4.0`, `CC0-1.0`). The license is read from the JATS `<permissions>`/`<license>` element and its license reference URL. This is the article-level reuse signal (the "R" in FAIR): a permissive license (CC BY, CC0) allows redistribution and text and data mining, whereas a restrictive license (NC / ND) or retained copyright does not.

Usage

rt_oa_pmc(filename, remove_ns = TRUE)

Arguments

filename

The filename of the PMC XML file to analyze.

remove_ns

Ignored since version 1.2.0 and kept for backward compatibility. Default XML namespaces are now always removed, so a namespaced PMC XML file gives the same result as a plain one.

Value

A tibble with the article IDs, whether the article is openly licensed (`is_open_access`), the canonical license (`oa_license`, `""` when none is found), the license statement (`oa_text`) and `is_success`.

Examples

# \donttest{
filepath <- system.file(
  "extdata", "PMID32171256-PMC7071725.xml", package = "rtransparency"
)
rt_oa_pmc(filepath)
#> # A tibble: 1 × 9
#>   pmid     pmcid_pmc  pmcid_uid doi   filename is_open_access oa_license oa_text
#>   <chr>    <chr>      <chr>     <chr> <chr>    <lgl>          <chr>      <chr>  
#> 1 32171256 PMC7071725 7071725   10.1… /home/r… TRUE           CC-BY-4.0  https:…
#> # ℹ 1 more variable: is_success <lgl>
# }