tcplPlotCalcAspectRatio: tcplPlotCalcAspectRatio

tcplPlotCalcAspectRatioR Documentation

tcplPlotCalcAspectRatio

Description

tcplPlotCalcAspectRatio

Usage

tcplPlotCalcAspectRatio(
  type = "mc",
  verbose = FALSE,
  multi = FALSE,
  nrows = 0,
  output = c("ggplot", "console", "pdf", "png", "jpg", "svg", "tiff"),
  group.threshold = 9,
  nrow = NULL,
  ncol = NULL,
  flags = FALSE
)

Arguments

type

string of mc or sc indicating if it is single or multi conc

verbose

should the plot return a table with parameters

multi

Boolean, by default TRUE for "pdf" if the number of plots exceeds one. Prints variable number of plots per page depending on 'verbose' and 'type' settings.

nrows

Integer, number of rows each compare plot uses

output

How should the plot be presented. To work with the plot in environment, use "ggplot"; to interact with the plot in application, use "console"; or to save as a file type, use "pdf", "jpg", "png", "svg", or "tiff".

group.threshold

Integer of length 1, minimum number of samples in a given plot where comparison plots, instead of coloring models by sample, should delineate curve color by a given group.fld. By default 9.

nrow

Integer, number of rows in multiplot. By default 2.

ncol

Integer, number of columns in multiplot. By default 3, 2 if verbose, 1 for compare plots.

flags

Boolean, by default FALSE. If TRUE, level 6 flags are displayed within output.

Value

a list of validated parameters for plotting


tcpl documentation built on June 8, 2025, 11:41 a.m.