connectivityMatrix: Builds a connectivity matrix from a connection object

Description Usage Arguments

View source: R/connectivityMatrices.R

Description

Builds a connectivity matrix from a connection object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
connectivityMatrix(
  connObj,
  slctROIs = NULL,
  allToAll = FALSE,
  from = "name.from",
  to = "name.to",
  ins = NULL,
  outs = NULL,
  value = "weightRelative",
  ref = c("inputs", "outputs")
)

Arguments

connObj

a connection table

slctROIs

which ROIs to consider. If NULL (the default), all the ROIs present in the table are used (columns of the matrix are then appended with .roi for each ROI)

allToAll

whether to build a square matrix or just a from -> to matrix

from

which field to use as a "source" (default "name.from")

to

which field to use as a "target" (default "name.to")

ins

optional vector of names : which inputs to consider (by default all present in the table). If missing from the table, will be filled with zeros.

outs

optional vector of names : which outputs to consider (by default all present in the table). If missing from the table, will be filled with zeros.

value

which field to use to fill the matrix (default "weightRelative")

ref

which channel will be used as the "reference" (to be the columns of the output). The other channel gets .roi affixed to their names in case several ROIs are considered


jayaraman-lab/neuprintrExtra documentation built on Dec. 20, 2021, 10 p.m.