getConnectionTable: Get connection table of inputs and add meta

Description Usage Arguments Value

View source: R/connectionTables.R

Description

Get connection table of inputs and add meta

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
getConnectionTable(
  bodyIDs,
  synapseType,
  slctROI = NULL,
  by.roi = FALSE,
  synThresh = 3,
  largeOnly = FALSE,
  chunk_connections = TRUE,
  chunk_meta = TRUE,
  verbose = FALSE,
  ...
)

Arguments

bodyIDs

The bodyids of neurons who's connections should be queried or a metadata data.frame

synapseType

Choose "PRE" or "POST" to get inputs or outputs of the neurons in bodyIDs, respectivly. "PRE" is usually slower as it requires listing all the outputs of the input neurons to get the contribution of the outputs.

slctROI

String specifying the ROI where connections should be queried. By default all the ROIs.

by.roi

Passed to neuprint_connection_table. If returning all ROIs, should results be broken down by ROI?

synThresh

Minimum number of synapses to consider a connection (default 3)

largeOnly

For cropped targets, only consider them if they have more than 1000 connections (matching Scheffer et al)

chunk_meta

: to be passed to metadata and roiInfo queries (default TRUE)

verbose

: should the function report on its progress?

...

Other arguments to be passed to neuprint queries (neuprint_connection_table, getRoiInfo and neuprint_get_meta)

chunk_connection

: to be passed to neuprint_connection_table (default TRUE)

Value

Returns a connection table as data frame. Added columns are weightRelativeTotal which is the relative weight considering all the synapses (irrespective of the ROI), and if ROI are used (either if slctROI has a value or by.roi is TRUE), weightRelative is the relative weight in the ROI and totalROIweight is the absolute number of inputs this neuron receives in that region and weightROIRelativeTotal is the weight in the ROI normalized by the total number of inputs (in all ROIs)


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