animateCA {eChem} | R Documentation |
Animate Chronoamperometry Simulation
Description
Creates either an HTML or a GIF animation of a
chronoamperometry simulation created using caSim
. The
resulting animation displays the diffusion profiles for Ox,
Red, and, where appropriate, Z situated above the
chronoamperogram. Note: the animateCA
function requires
that the animation
package is installed.
Usage
animateCA(filename, out_type = c("html", "gif"), out_name = "aniCA")
Arguments
filename |
Name of the file that contains the results of a chronoamperometry simulation. |
out_type |
Identifies the type of file generated, either an HTML file or a GIF file. |
out_name |
Name used for the file(s) created by this function. |
Value
For an HTML animation, the function saves four items in the working directory: a folder with CSS files, a folder with javascript files, a folder with the image files for the animation, and a .html file; the latter two files are named using the function's out_name
argument. For a GIF animation, the function saves a single .gif file using the function's out_name
argument. See the vignettes for examples.