QuickPlot: Quick plot various type of data.

In Crystal-YWu/abftools: ABF Tools: Toolbox for Visualising and Analysing Electrophysiology ABF2 Data

Description

QuickPlot automatically select proper plotting functions according to the type of data and arguments provided. You can always try QuickPlot first if you don't know how to plot or what plotting function to use before consulting manual.

Usage

QuickPlot(data, ...)

## Default S3 method:
QuickPlot(data, ...)

## S3 method for class 'abf'
QuickPlot(abf, pos = NULL, intv = NULL, cursor = NULL,
  time_unit = NULL, colour = FALSE, title = NULL,
  legend_title = NULL, zero_intercept = TRUE, zero_axes = TRUE,
  line_size = 0.5)

## S3 method for class 'matrix'
QuickPlot(data, ...)

## S3 method for class 'data.frame'
QuickPlot(df, colour = FALSE, ...)

## S3 method for class 'list'
QuickPlot(data, pos = NULL, colour = TRUE,
  title = NULL, legend_title = NULL, zero_intercept = TRUE,
  zero_axes = TRUE, line_size = 0.5, marker_size = line_size * 4,
  err_bar_size = line_size/1.75, err_bar_width = marker_size * 1.25,
  smooth = FALSE)

Arguments

data	data to plot, QuickPlot will try its best to figure out how to plot.
...	not used.
pos	positions to sample and calculate values, can be interval or cursor.
intv	interval compatible with PlotChannel(), also used to sample and calculate values.
cursor	cursor compatible with PlotChannel(), also used to sample and calculate values.
time_unit	unit of time.
colour	whether to plot in colour mode.
title	OPTIONAL, title for the plot.
legend_title	OPTIONAL, legend title for the plot.
zero_intercept	whether to add zero intercepts.
zero_axes	whether to force position axes at 0.
line_size	size of lines.
marker_size	size of markers, not used when plotting abf objects.
err_bar_size	size of error bars, not used when plotting abf objects.
err_bar_width	width of error bars, not used when plotting abf objects.

Details

When plotting an abf object, the type of generated plot is determined by this logic: 1. Whether the abf object has only one channel, if so, a channel plot is generated. 2. Whether time_unit is given, if so, plot all channels and convert x axis to time_unit. 3. Whether the abf object has only one episode, if so, a channel plot of time unit "tick" is generated.

Value

a ggplot object

Crystal-YWu/abftools documentation built on May 10, 2019, 8:22 a.m.