ImportPRecording: Import electrophysiology recordings

View source: R/ImportPRecording.R

ImportPRecordingR Documentation

Import electrophysiology recordings

Description

[Stable]
This function imports electrophysiology recordings from PatchMaster *.dat files ("Series") or Axon's ABF files and creates a PRecording object. Support for WinWCP files is thought in future.

Usage

ImportPRecording(
  filename,
  experiment = 1,
  series = 1,
  traces = c(1, 2),
  encoding = getOption("encoding"),
  filetype = NULL,
  verbose = FALSE
)

Arguments

filename

Path to file. Currently only Patch Master .dat and Axon Binary (.abf) files are supported.

experiment

Index of the experiment to import. Only required if filename is a PatchMaster file. The experiment is the 1st order hierarchy in PatchMaster file tree. Default is 1.

series

Index of the series to import Only required if filename is a PatchMaster file. The series is the 2nd order hierarchy in PatchMaster file tree. Default is 1.

traces

Index or indices of Traces/channels to import. The trace is the 3rd order hierarchy in PatchMaster file tree. Must be vector of numeric of length > 0. Default is c(1,2).

encoding

File encoding to use, default is getOption("encoding")

filetype

The type of the file to be imported. Accepted values are 'PatchMaster' or 'ABF' If left blank (default), it will be guessed from the file extension.

verbose

Whether to display verbose messages during the import process. Default is FALSE.

Value

A PRecording object

See Also

PRecording

Examples

## Not run: 
# import a PatchMaster file
tmp<-ImportPRecording("test.dat",series = 1,traces = c(1,2))

## End(Not run)

moritzlindner/PatchMasteR documentation built on April 30, 2024, 1:52 a.m.