R: Save additional frames for overlapping neurons from SCALPEL.

reviewOverlappingNeurons {scalpel}

R Documentation

Save additional frames for overlapping neurons from SCALPEL.

Description

We use this function after running reviewNeurons or reviewNeuronsInteractive to plot additional frames for neurons that overlap with others. These frames are saved, and the classification for the neurons can then be updated using updateNeurons or updateNeuronsInteractive.

Usage

reviewOverlappingNeurons(scalpelOutput, neuronSet, numFrames = 10)

Arguments

`scalpelOutput`	An object returned by one of the SCALPEL functions: `scalpel`, `scalpelStep2`, or `scalpelStep3`.
`neuronSet`	The set of neurons that should be reviewed: use `"A"` for those resulting from `scalpelStep2` and saved as `scalpelOutput$A`, or use `"Afilter"` for those resulting from `scalpelStep3` and saved as `scalpelOutput$Afilter`. This argument is ignored if the class of `scalpelOutput` is `scalpelStep2`.
`numFrames`	The maximum number of frames that should be saved for each neuron being considered. Each neuron has a number of frames equal to the number of members in that neuron's cluster that can be plotted. All frames will be saved when the total number of available frames for the neuron is less than `numFrames`. The default value is 10.

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 example for the "reviewNeuronsInteractive" function

reviewOverlappingNeurons(scalpelOutput = scalpelOutput, neuronSet = "A")

## End(Not run)