summary.neuron: Summary statistics for neurons (e.g. cable length, number of...

In nat: NeuroAnatomy Toolbox for Analysis of 3D Image Data

Summary statistics for neurons (e.g. cable length, number of nodes)

Description

summary.neuronlist computes tree statistics for all the neurons in a neuronlist object

summary.neuron computes statistics for individual neurons

summary.dotprops computes statistics for individual neurons in dotprops format. Note the veclength argument.

Usage

## S3 method for class 'neuronlist'
summary(object, ..., include.attached.dataframe = FALSE)

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

## S3 method for class 'dotprops'
summary(object, veclength = 1, ...)

Arguments

object	The neuron or neuronlist to summarise
...	For summary.neuronlist additional arguments passed on to summary methods for individual neurons
include.attached.dataframe	Whether to include the neuronlists attached metadata in the returned data.frame.
veclength	The vector length to assume for each segment so that a cable length estimate can be made.

Value

A data.frame summarising the tree properties of the neuron with columns

• root

• nodes

• segments

• branchpoints

• endpoints

• cable.length

See Also

seglengths

Examples

# summary for a whole neuronlist
summary(Cell07PNs)
# including the attached data.frame with additional metadata
head(summary(Cell07PNs, include.attached.dataframe = FALSE))
# for a single regular format neuron
summary(Cell07PNs[[1]])
# for a single dotprops format neuron
summary(kcs20[[1]])
# specify a different estimate for the cable length associated with a single
# point in the neuron
summary(kcs20[[1]], veclength=1.2)

nat documentation built on May 29, 2024, 10:36 a.m.