summary: Summarize results from SCALPEL pipeline.

In scalpel: Processes Calcium Imaging Data

Description

Prints the parameters used and a summary of results for a specified step of SCALPEL.

Usage

## S3 method for class 'scalpelStep0'
summary(object, ...)

## S3 method for class 'scalpelStep1'
summary(object, ...)

## S3 method for class 'scalpelStep2'
summary(object, ...)

## S3 method for class 'scalpelStep3'
summary(object, ...)

## S3 method for class 'scalpel'
summary(object, step, ...)

Arguments

object	An object returned by one of the SCALPEL functions: scalpel, scalpelStep0, scalpelStep1, scalpelStep2, or scalpelStep3.
...	Additional arguments to be passed, which are ignored in this function.
step	The SCALPEL step (0, 1, 2, or 3) that you wish to summarize. This is only needed if summarizing an object of class scalpel.

Value

None

Examples

## Not run: 
### many of the functions in this package are interconnected so the
### easiest way to learn to use the package is by working through the vignette,
### which is available at ajpete.com/software

#assumes you have run the examples for the "scalpelStep0" and "scalpel" functions
summary(Step0Out)
 #summarize each step
 summary(scalpelOutput, step = 0)
 summary(scalpelOutput, step = 1)
 summary(scalpelOutput, step = 2)
 summary(scalpelOutput, step = 3)

## End(Not run)

scalpel documentation built on Feb. 3, 2021, 9:05 a.m.