sub_dist_mat: Convert (a subset of) a raw score matrix to a distance matrix
In nat.nblast: NeuroAnatomy Toolbox ('nat') Extension for Assessing Neuron Similarity and Clustering
Description
Usage
Arguments
Details
Value
See Also
Description
This function can convert a raw score matrix returned by nblast
into a square distance matrix or dist object. It can be used with
file-backed matrices as well as regular R matrices resident in memory.
Usage
1
2
sub_dist_mat(neuron_names, scoremat = NULL, form = c("matrix", "dist"),
maxneurons = NA)
Arguments
neuron_names
character vector of neuron identifiers.
scoremat
score matrix to use (see sub_score_mat for details of
default).
form
the type of object to return.
maxneurons
set this to a sensible value to avoid loading huge (order
N^2) distances directly into memory.
Details
Note that if neuron_names is missing then the rownames of
scoremat will be used i.e. all neuron in scoremat will be used.
Value
return An object of class matrix or dist (as determined by the form
argument), corresponding to a subset of the distance matrix
See Also
Other scoremats: nhclust
nat.nblast documentation built on May 29, 2017, 11:35 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Description Usage Arguments Details Value See Also
Description
This function can convert a raw score matrix returned by nblast
into a square distance matrix or dist object. It can be used with
file-backed matrices as well as regular R matrices resident in memory.
Usage
1 2 | sub_dist_mat(neuron_names, scoremat = NULL, form = c("matrix", "dist"),
maxneurons = NA)
|
Arguments
neuron_names |
character vector of neuron identifiers. |
scoremat |
score matrix to use (see |
form |
the type of object to return. |
maxneurons |
set this to a sensible value to avoid loading huge (order N^2) distances directly into memory. |
Details
Note that if neuron_names is missing then the rownames of
scoremat will be used i.e. all neuron in scoremat will be used.
Value
return An object of class matrix or dist (as determined by the form argument), corresponding to a subset of the distance matrix
See Also
Other scoremats: nhclust
R Package Documentation
Browse R Packages
We want your feedback!
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.