Skip to contents

Identify use of a reporting guideline from a TXT file.

Source: R/rt_reporting.R
rt_reporting.Rd

The plain-text counterpart of [rt_reporting_pmc()]. Detects whether an article states that it followed a reporting guideline and which one, using the same precision-first rules.

Usage

rt_reporting(filename = NULL, text = NULL)

Arguments

filename

The path to a TXT file as a string.

text

Alternatively, the article text itself as a character vector (for example the output of [rt_read_pdf()]). Supply `filename` or `text`.

Value

A tibble with the file name (`article`), the PMID (`NA` if absent), whether a reporting-guideline statement was found (`is_reporting_pred`), the guideline(s) named (`reporting_guideline`) and the matched statement (`reporting_text`).

See also

[rt_reporting_pmc()] for the PMC XML detector.

Examples

# \donttest{
# Write a short example article to a temporary text file.
filepath <- file.path(tempdir(), "PMID00000000-PMC0000000.txt")
writeLines(
  "This systematic review was reported following the PRISMA 2020 guideline.",
  filepath
)
rt_reporting(filepath)
#> # A tibble: 1 × 5
#>   article             pmid  is_reporting_pred reporting_guideline reporting_text
#>   <chr>               <chr> <lgl>             <chr>               <chr>         
#> 1 PMID00000000-PMC00… 0000… TRUE              PRISMA              This systemat…
# }