Get: Accession methods

In moritzlindner/PatchR: An environment for working with ephys (PatchClamp) recordings

Accession methods

Description

These methods are used to access information from PRecording and/or PCollection objects

Usage

GetSweepNames(X)

GetTraceNames(X)

GetTimeTrace(X)

GetSweepTimes(X)

GetCSlow(X)

GetRecParam(X, which)

GetGroupMembers(X, which)

GetGroupNames(X)

GetGroups(X)

GetRecordingNames(X)

GetMetaData(X, which = colnames(X@MetaData))

GetPlotNames(X)

GetPlot(X, which = colnames(X@MetaData))

GetData(
  X,
  Traces = GetTraceNames(X),
  Sweeps = GetSweepNames(X),
  Time = range(GetTimeTrace(X)),
  Recordings = NULL,
  Group = NULL,
  TimeExclusive = F,
  nowarnings = F
)

Subset(
  X,
  Traces = GetTraceNames(X),
  Sweeps = GetSweepNames(X),
  Time = range(GetTimeTrace(X)),
  Recordings = NULL,
  Group = NULL,
  TimeExclusive = F,
  nowarnings = F
)

Arguments

X	A PRecording or PCollection object
which	A name of a valid Group in a PCollection (for GetGroupMembers). 2) A name or a vector of names of slot(s) in RecordingParams (for GetRecParam). or 3) A name or a vector of names of a column in the MetaData slot (for GetMetaData).
Traces	List of traces/channels to keep
Sweeps	List of sweeps to keep
Time	either a range of time points to keep or two particular time points
Recordings	Subset by series/recordings. Understands names (= file names of the recordings) or indices or by logical indexing. Only for PCollection .
Group	Subset by Group name. Only for PCollection .
TimeExclusive	Keep only the two time points stated under Time, not the range
nowarnings	Supress warning messages.

Details

These methods can be used to access information stored in PRecording and/or PCollection objects.

Value

A numeric vector.

For GetMetaData a vector of type numeric or a matrix.

For GetPlotNames a vector of type character.

For GetPlot a ggplot.

For GetData A PRecording or PCollection object.

Functions

• GetSweepNames: Returns the Sweep names.

• GetTraceNames: Return the Trace names.

• GetTimeTrace: Returns a vector containing the times at which the individual sweeps were recorded.

• GetSweepTimes: Returns a vector containing the times at which the individual sweeps were recorded.

• GetCSlow: This is a special case of GetRecParam and returns the C-slow value.

• GetRecParam: Returns any value stored in the RecordingParams slot.

• GetGroupMembers: Can be used on PCollection objects only and returns the names of all PRecordings belonging to the named Group.

• GetGroupNames: Can be used on PCollection objects only and returns the names of all groups.

• GetGroups: Can be used on PCollection objects only and returns the groups.

• GetRecordingNames: Can be used on PCollection objects only and returns the names of all recordings.

• GetMetaData: Returns one or more columns from the MetaData Slot.

• GetPlotNames: Returns the names of the plots stored in the Plots Slot.

• GetPlot: Returns a plot from the Plots slot.

• GetData: This method subsets objects by Trace, Sweep or Time. For PCollection additionally by Recordings or Group

• Subset: Subset is an alias of Getdata

moritzlindner/PatchR documentation built on April 30, 2024, 1:40 a.m.