foodwebWrapper {foodwebWrapper}

foodwebWrapper

Description

wrapper for the function foodweb() concatenate the R package name for each retrieved R function

Usage

foodwebWrapper(
  where = character(0),
  ofile = "~/foodwebWrapper.html",
  zeros = TRUE,
  pawn = FALSE,
  verbose = TRUE
)

Arguments

where

position(s) on search path, or an environment, or a list of environments

ofile

character string containing path name for output file

zeros

Boolean if TRUE delete rows and cols that contain all 0's

pawn

Boolean if TRUE use chess symbols rather than rectangles in html table

verbose

Boolean if TRUE output several user messages

Details

if where is missing, then the user is presented with the option of choosing from a list of attached packages

Value

foodweb returns an object of (S3) class foodweb. This has three components:

• funmat a matrix of 0s and 1s showing what (row) calls what (column). The dimnames are the function names.

• x shows the x-axis location of the centre of each function's name in the display, in par("usr") units

• level shows the y-axis location of the centre of each function's name in the display, in par("usr") units. For small numbers of functions, this will be an integer; for larger numbers, there will some adjustment around the nearest integer

Examples

if(interactive()){
load("data/x_packages.RData")
ofile<-sprintf("%s/foodwebWrapper.html",tempdir())
foodwebWrapper(ofile=ofile)
foodwebWrapper(where=x_packages,ofile=ofile)
}