Plot: Plotting methods

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

Plotting methods

Description

These methods create "typical" electrophysiology graphs, like stimulus-response curves, time-series or point statistics.

Usage

BuildStimRespPlot(
  X,
  StimTrace = "V-mon",
  RespTrace = "I-mon",
  Time,
  fun = mean,
  ReturnPObject = T
)

BuildTimeSeriesPlot(
  X,
  RespTrace = "I-mon",
  Time,
  fun = mean,
  ReturnPObject = T
)

BuildGroupComparisonPlot(
  X,
  Sweep,
  RespTrace = "I-mon",
  Time,
  fun = mean,
  ReturnPObject = T
)

BuildQCPlot(X, ReturnPObject = T)

BuildRecordingPlot(X)

Arguments

X	A PRecording or PCollection object
StimTrace	The name of the trace that contains the stimulus
RespTrace	The name of the trace that contains the response
Time	either a range of time points to keep or two particular time points
fun	Function to apply on graph for stimulus response plotting
ReturnPObject	whether to return a PRecording/PCollection or a matrix.
Sweep	Sweep to analyse for group comparison

Value

A PCollection with an item added to the Plots slot if ReturnPObject=T or a ggplot.

Functions

• BuildStimRespPlot: This method builds a stimulus-response curve

• BuildTimeSeriesPlot: This method builds a time Series plot

• BuildGroupComparisonPlot: This method builds a boxplot for comparison between groups as stored in the PCollection.

• BuildQCPlot: This function creates a basic visualization of quality-relevant recording parameters in the PCollection

• BuildRecordingPlot: This function creates a basic visualization for each Trace in a single PRecording object.

See Also

Inspect, Measure, GetPlot, GetPlotNames

Examples

# Build a stimulus response curve from a single recording. Here, a current
# response, averaged from 0.8-1s of the trace is used. A PRecording object with
# an updated slot Plots is returned.
data(PRecording)
SampleData<-BuildStimRespPlot(
  SampleData,
  StimTrace = "V-mon",
  RespTrace = "I-mon",
  Time = c(0.8,1),
  fun = mean,
  ReturnPObject = TRUE
)
# Interactively analyse graph
Inspect(SampleData,"StimRespPlot")

 # Build a time series. Average is taken from RespTrace between 0.8s and 1s for
 # each sweep and is plotted against the timestamp of the sweep. The graph
 # (ggplot) is returned directly.
BuildTimeSeriesPlot(SampleData,
   RespTrace = "I-mon",
   Time = c(0.8,1),
   fun = mean,
   ReturnPObject = FALSE)

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