R/roxygen2_functions.R

In RGLab/DataPackageR: Construct Reproducible Analytic Data Sets as R Packages

comments <- function(refs) {
  srcfile <- attr(refs[[1]], "srcfile")
  com <- vector("list", length(refs))
  for (i in seq_along(refs)) {
    if (i == 1) {
      first_byte <- 1
      first_line <- 1
    } else {
      first_byte <- refs[[i - 1]][4] + 1
      first_line <- refs[[i - 1]][3]
    }
    last_line <- refs[[i]][3]
    last_byte <- refs[[i]][4]
    lloc <- c(first_line, first_byte, last_line, last_byte)
    com[[i]] <- srcref(srcfile, lloc)
  }
  com
}

#' @importFrom stats setNames
#' @importFrom stringr str_trim
read.description <- function(file) {
  dcf <- read.dcf(file, keep.white = "Authors@R")
  dcf_list <- stats::setNames(as.list(dcf[1, ]), colnames(dcf))
  lapply(dcf_list, stringr::str_trim)
}

read_pkg_description <- function(path) {
  desc_path <- file.path(path, "DESCRIPTION")
  if (!file.exists(desc_path)) {
    stop("Can't find DESCRIPTION")
  }
  read.description(desc_path)
}