PlotWidths: Plot Widths

In THJlab/seqNdisplayR: A Tool for Customizable and Reproducible Plotting of Sequencing Coverage Data

Plot Widths

Description

Internal function: Make sense of the supplied width arguments

Usage

PlotWidths(
  panels_max_width_cm,
  scale_panel_width_cm,
  margin_width_cm,
  track_width_cm,
  full_width_cm,
  incl_track_scales,
  verbosity,
  interface
)

Arguments

panels_max_width_cm	maximum width (in cm) of the combined panels plotted to the left of the data tracks ('auto'/'automatic' or positive numeric value) - 'auto' is only accepted if full_width_cm=NULL
scale_panel_width_cm	width (in cm) of the scale panel plotted to the left of the data tracks and to the right of all other panels ('auto'/'automatic' or positive numeric value) - 'auto' is only accepted if full_width_cm=NULL
margin_width_cm	width (in cm) of the margins on each side of the data tracks (NULL or positive numeric value - will auto-default with warning message)
track_width_cm	width (in cm) of the data tracks (NULL or positive numeric value)
full_width_cm	width (in cm) of the full plotted area (NULL or positive numeric value)
incl_track_scales	if TRUE tracks scales will be included (left of the data tracks and to the right of all other panels)
verbosity	indicated by an integer 0 to 3 referring to the levels 'off', 'no warnings', 'normal', and 'detailed'
interface	'R' or 'shiny'

Value

a named vector with values for 'panels.max.width.cm', 'scale.panel.width.cm', 'margin.width.cm', 'track.width.cm' and 'full.width.cm'

Note

the following expression needs to be true: full_width_cm = panels_max_width_cm + scale_panel_width_cm + track_width_cm + 2 * margin_width_cm consider setting one of the arguments "full_width_cm" or "track_width_cm" to NULL

Author(s)

SLA

Examples

plot_widths = PlotWidths(panels_max_width_cm='auto', scale_panel_width_cm='auto', margin_width_cm=0.05, track_width_cm=12, full_width_cm=NULL, incl_track_scales=TRUE, verbosity=3, interface='R')
plot_widths = PlotWidths(panels_max_width_cm='auto', scale_panel_width_cm='auto', margin_width_cm=0.05, track_width_cm=12, full_width_cm=15, incl_track_scales=TRUE, verbosity=3, interface='R')
plot_widths = PlotWidths(panels_max_width_cm=2, scale_panel_width_cm=0.6, margin_width_cm=0.05, track_width_cm=12, full_width_cm=15, incl_track_scales=TRUE, verbosity=3, interface='R')
plot_widths = PlotWidths(panels_max_width_cm=2.3, scale_panel_width_cm=0.6, margin_width_cm=0.05, track_width_cm=12, full_width_cm=15, incl_track_scales=TRUE, verbosity=3, interface='R')
plot_widths = PlotWidths(panels_max_width_cm=2, scale_panel_width_cm=0.6, margin_width_cm=0.05, track_width_cm=NULL, full_width_cm=15, incl_track_scales=TRUE, verbosity=3, interface='R')

THJlab/seqNdisplayR documentation built on Nov. 13, 2024, 10:36 a.m.