getNeuronStatus: Read in the manual classifications of neurons from SCALPEL.

In scalpel: Processes Calcium Imaging Data

Description

This function allows the user to read in the manual classifications of neurons, based on the classifying done using reviewNeurons or reviewNeuronsInteractive.

Usage

getNeuronStatus(scalpelOutput, neuronSet)

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.

Value

A vector of length equal to the number of columns in scalpelOutput$A if neuronSet="A" or scalpelOutput$Afilter if neuronSet="Afilter". The elements give the manual classifications of the neurons. The possible classifications are: "yes" if a neuron is to be kept, "no" if a neuron is to be discarded, "unsure" if a neuron needs to be reviewed further, and NA if a neuron has not yet been classified.

See Also

reviewNeurons, reviewNeuronsInteractive

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 "updateNeurons" function

getNeuronStatus(scalpelOutput = scalpelOutput, neuronSet = "Afilter")

## End(Not run)

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