R/Context-class.R

In BiocCheck: Bioconductor-specific package checks

#' Construct a data.frame to summarize location of events
#'
#' @param pkg character(1) name of the package
#' @param file character(1) full path (including package name) of file
#'     being summarized.
#' @param lines character() vector of text lines in file
#' @param idx logical() same length as \code{lines} indicating lines
#'     in which event occurs
#'
#' @return a data.frame() with columns File, Line, and Context
Context <- function(pkg="", file="", lines=character(), idx=logical()) {
    data.frame(
        File=rep(mungeName(file, pkg), sum(idx)), Line=which(idx),
        Context=lines[idx], stringsAsFactors=FALSE)
}

#' Report context of events to user
#'
#' @param ctxt Object derived from Context()
#'
#' @return None; side effect is output on the message stream
handleContext <- function(ctxt, nlines=6, width=getOption("width")) {
    ctxt <- head(ctxt, nlines)
    txt <- c(
        sprintf("First %d lines:", nrow(ctxt)),
        sprintf("%s:%d %s", ctxt$File, ctxt$Line, ctxt$Context))
    handleVerbatim(txt, width=width)
}