print.spikeTrain: Print and Summary Methods for spikeTrain Objects

In STAR: Spike Train Analysis with R

Description

Print and summary methods for spikeTrain objects.

Usage

## S3 method for class 'spikeTrain'
print(x,...)
## S3 method for class 'spikeTrain'
summary(object, timeUnit = "s", digits = 3, ...)

Arguments

x, object	A spikeTrain object.
timeUnit	The unit with which the occurrence times were measured.
digits	The number of digits used to print the summary (see round).
...	see print and summary.

Details

print.spikeTrain does in fact call the plot method for spikeTrain objects.

Value

print.spikeTrain generates a plot as a side effect.

summary.spikeTrain returns the number of spikes, the times of the first and last spikes, the mean inter-spike interval (ISI) and its sd as well as the mean and sd of the log(ISI) together with the shortest and longest ISIs.

Author(s)

Christophe Pouzat [e-mail]

See Also

as.spikeTrain, is.spikeTrain, renewalTestPlot, varianceTime, stepfun

Examples

## load spontaneous data of 4 putative projection neurons
## simultaneously recorded from the cockroach (Periplaneta
## americana) antennal lobe
data(CAL1S)
## convert data into spikeTrain objects
CAL1S <- lapply(CAL1S,as.spikeTrain)
## look at the individual trains
## first the "raw" data
CAL1S[["neuron 1"]]
## next some summary information
summary(CAL1S[["neuron 1"]])

Example output

Loading required package: survival
Loading required package: mgcv
Loading required package: nlme
This is mgcv 1.8-28. For overview type 'help("mgcv-package")'.
Loading required package: R2HTML
Loading required package: gss
Loading required package: codetools
A spike train with 195 events, starting at: 0.318 and ending at: 30.379 (s).
The mean ISI is: 0.155 and its SD is: 0.283 (s).
The mean log(ISI) is: -2.838 and its SD is: 1.291
The shortest interval is: 0.007
 and the longest is: 1.99 (s).

STAR documentation built on May 2, 2019, 11:44 a.m.