eChem (version 1.0.0)

plotCC: Plot Chronocoulograms

Description

Plots 1--5 chronocoulograms on a single set of axes. The default plot does not include a legend or a title, but providing a vector of character strings to legend_text adds a legend to the final plot, and adding a character string for main_title adds a title to the plot. Line widths, line types, line colors, point symbols, and point colors have default values that can be adjusted. Note: this function accepts both full data files created using ccSim or reduced data files created using sampleCoulgram.

Usage

plotCC(filenames = list(file1 = NULL, file2 = NULL), scale = 1,
  legend_text = NULL, legend_position = "topleft", main_title = NULL,
  line_widths = c(2, 2, 2, 2, 2), line_types = c(1, 2, 3, 4, 5),
  point_symbols = c(21, 22, 23, 24, 25), line_colors = c("blue", "blue",
  "blue", "blue", "blue"))

Arguments

filenames

A list giving the names of 1--5 files that contain the results of a simulated chronocoulometry experiment.

scale

Setting to value less than 1 adjusts the y-axis limits so that the limits are not defined by the current spike.

legend_text

Optional vector that contains text to include in a legend. Default is NULL, which surpresses the legend.

legend_position

legend_position One of topleft, topright, bottomleft, or bottomright; defaults to topleft.

main_title

An optional main title.

line_widths

A vector of line widths for the individual voltammograms; defaults to a common line width of 2, but can be adjusted by supplying a vector with desired values.

line_types

A vector of line types for the individual voltammograms; defaults to a set of different line types, but can be adjusted by supplying a vector with desired values.

point_symbols

A vector of pch values for plotting points.

line_colors

A vector of colors for the individual voltammograms, whether displayed as lines or as points; defaults to a common color, but can be adjusted by supplying a vector with desired values.

Value

Returns a plot that shows time on the x-axis and charge on the y-axis.

Examples

# NOT RUN {
ca_ex1 = simulateCA(conc.bulk = 0.01, x.units = 100, t.units = 1000)
cc_ex1 = simulateCC(ca_ex1)
ca_ex2 = simulateCA(conc.bulk = 0.001, x.units = 100, t.units = 1000)
cc_ex2 = simulateCC(ca_ex2)
ca_ex3 = simulateCA(conc.bulk = 0.0001, x.units = 100, t.units = 1000)
cc_ex3 = simulateCC(ca_ex3)
plotCC(filenames = list(cc_ex1, cc_ex2, cc_ex3),
  legend_text = c("0.01 M", "0.001 M", "0.0001 M"), scale = 0.8)
# }