tests/testthat/_snaps/object-package.md

In r-lib/roxygen2: In-Line Documentation for R

person turned into meaningful text

Code
  # Multiple given/family names
  person_desc(c("First", "Second"), c("Family1", "Family2"))
Output
  [1] "First Second Family1 Family2 \\email{[e-mail]}"
Code
  # Multiple roles
  person_desc(role = "ctb")
Output
  [1] "H W \\email{[e-mail]} [contributor]"
Code
  # ORCID comments
  person_desc(comment = c(ORCID = "1234"))
Output
  [1] "H W \\email{[e-mail]} (\\href{https://orcid.org/1234}{ORCID})"
Code
  person_desc(comment = c(ORCID = "https://orcid.org/1234"))
Output
  [1] "H W \\email{[e-mail]} (\\href{https://orcid.org/1234}{ORCID})"
Code
  person_desc(comment = c(ORCID = "1234", "extra"))
Output
  [1] "H W \\email{[e-mail]} (\\href{https://orcid.org/1234}{ORCID}) (extra)"

useful message if Authors@R is corrupted

Code
  package_authors("1 + ")
Message
  x Failed to evaluate Authors@R.
  Caused by error in `parse()`:
  ! <text>:2:0: unexpected end of input
  1: 1 + 
     ^
Output
  NULL
Code
  package_authors("stop('Uhoh')")
Message
  x Failed to evaluate Authors@R.
  Caused by error:
  ! Uhoh
Output
  NULL

r-lib/roxygen2 documentation built on April 21, 2024, 4:36 a.m.