getMapStats-methods: Calculate spatial statistics of the firing rate maps of...

In kevin-allen/relectro: Analysis of electrophysiological data

Description

Calculate spatial statistics of the firing rate maps of neurons

Usage

getMapStats(sp, st, pt, border = "rectangular", triggered = F,
  newMaps = T)

## S4 method for signature 'SpatialProperties2d'
getMapStats(sp, st, pt,
  border = "rectangular", triggered = FALSE, newMaps = TRUE)

Arguments

sp	SpatialProperties2d object
st	SpikeTrain object
pt	Positrack object
border	Set how the border of the environment will be detected. Value can be set to "rectangular" or "circular". Default value is "rectangular"
triggered	Logical indicating whether to calculate a spike-triggered firing rate map instead of conventional map Default value is FALSE
newMaps	logical indicating if new maps are calculated when calling the function

Value

SpatialProperties2d object with the stats in the following slots: peakRate, infoScore, sparsity, borderScore and gridScore

kevin-allen/relectro documentation built on May 20, 2019, 9:06 a.m.