arbour.clusters: Segregate neurite compartments from a neuron/neuronlist based...

View source: R/neurites.R

arbour.clustersR Documentation

Segregate neurite compartments from a neuron/neuronlist based on synapse clustering

Description

Fragment a skeleton into compartments that have been assigned cluster_synapses_within_skeleton() or flow.centrality(). Note that this will break down a neuron regardless of the segregation score calculated across the arbour.

Usage

arbour.clusters(x, ...)

## S3 method for class 'neuron'
arbour.clusters(x, ...)

## S3 method for class 'neuronlist'
arbour.clusters(x, neuronlist = FALSE, ...)

arbours(arbourcluster, ...)

## S3 method for class 'neuron'
arbours(arbourcluster, ...)

## S3 method for class 'neuronlist'
arbours(arbourcluster, ...)

Arguments

x

a neuronlist that has been processed by flow.centrality

...

additional arguments passed to methods.

neuronlist

whether or not to return a neuronlist where each entry is one of the broken up arbours (TRUE)

arbourcluster

a neuronlist produced from arbour.clusters

Value

Segmented arbours as a neuronlist object, complete with synaptic information relevant to that fragment. If a neuronlist is given, subsequently plotting the neuronlist will not reveal the fragments. However, plotting individual neurons double indexed in the lists will. arbours() returns a neuronlist, where each entry is an arbour fragment with a unique skid and name.

See Also

neurites cluster_synapses_within_skeleton seebroken3d flow.centrality seesplit3d


alexanderbates/catnat documentation built on Sept. 5, 2023, 4:51 a.m.