Learn R Programming

IFC (version 0.1.2)

CreateGraphReport: Graph Report Generation

Description

Generates graph report (plot + statistics) from `IFC_data` object.

Usage

CreateGraphReport(
  obj,
  selection,
  onepage = TRUE,
  color_mode = c("white", "black")[1],
  add_key = "panel",
  precision = c("light", "full")[1],
  trunc_labels = 38,
  trans = asinh,
  bin,
  viewport = "ideas",
  display_progress = TRUE,
  ...
)

Arguments

obj

an `IFC_data` object extracted with features extracted.

selection

when provided, indices of desired graphs. In such case 'onepage' parameter is set to FALSE. Note that indices are read from left to right, from top to bottom.

onepage

whether to generate a pdf with all graphs on one page or not. Default is TRUE.

color_mode

Whether to extract colors from obj in white or black mode. Default is "white".

add_key

whether to draw a "global" key under title or in the first "panel" or "both". Default is "panel". Accepted values are either: FALSE, "panel", "global", "both" or c("panel", "global"). Note that it only applies when display is seen as overlaying populations.

precision

when graphs is a 2D scatter with population overlay, this argument controls amount of information displayed. Default is "light". -"light", the default, will only display points of same coordinates that are among the other layers. -"full" will display all the layers.

trunc_labels

maximum number of characters to display for labels. Default is 38.

trans

transformation function for density graphs. If missing the default, the BasePop[[1]]$densitytrans, if any, will be retrieved, otherwise asinh will be used.

bin

default number of bin used for histogram. Default is missing.

viewport

Either "ideas", "data" or "max" defining limits used for the graph. Default is "ideas". -"ideas" will use same limits as the one defined in ideas. -"data" will use data to define limits. -"max" will use data and regions drawn to define limits.

display_progress

whether to display a progress bar. Default is TRUE.

...

other parameters to be passed.

Value

a list with onepage, layout, layout_matrix, graphs, grobs, and stats.