Context {BiocCheck}R Documentation

Report context of events to user with a data.frame of events and locations

Description

Report context of events to user with a data.frame of events and locations

Usage

Context(pkg = "", file = "", lines = character(), idx = logical())

handleContext(ctxt, nlines = 6, width = getOption("width"))

Arguments

pkg

character(1) name of the package

file

character(1) full path (including package name) of file being summarized.

lines

character() vector of text lines in file

idx

logical() same length as lines indicating lines in which event occurs

ctxt

Object derived from Context()

nlines

numeric(1) The number of lines to provide context for.

width

numeric(1) The width of the console; defaults to the value given by getOption("width")

Value

Context: a data.frame() with columns File, Line, and Context

handleContext: side effect is output on the message stream


[Package BiocCheck version 1.30.0 Index]