R/__docu_ephys2.R

In tdanker/ephys2: Read, analyze and plot HEKA Patchmaster files

#' Read, plot and analyse HEKA Patchmaster data
#'
#' To load Patchmaster files, first get the tree structure with \link{get_treeinfo}. 
#' The resulting tree object can be used to explore the whole data set with \link{showtree}, a shiny app
#' that will allow you to visually explore the data files, 
#' interactively set analysis cursors, 
#' annotate you data and calculate and display summary results. 
#' 
#' Single series of patch clamp data can be extracted from the tree with \link{getSeries}, 
#' which generates a proto object with methods for plotting the data, 
#' setting analysis cursors programmatically or interactively, 
#' obtaining and plotting of cursor analysis results ( e.g. I/t plots and I/V plots ). 
#' 
#' Plotting routines in this package support typical ephys plotting style with scalebars.
#'  
#' for more on plotting annotated Itplots and DRC curves see example in \link{getSeries}  
#' 
#' @examples
#' tree <- get_treeinfo(examplefile("herg"))
#' s<-getSeries(tree,1,1,1)
#' s$plot(main="Example hERG data with cursor analysis")
#' title(sub=paste("peak current: ", s$results()$peak, "nA"))

"_PACKAGE"
# > [1] '_PACKAGE'