R/plot.spiketrain.R

#' plot.spiketrain
#'
#' This file is part of the rephys package.
#'
#' Copyright(c) Martin Rüßler
#'
#' This file may be licensed under the terms of of the
#' GNU General Public License Version 3 (the ``GPL''),
#' or (at your option) any later version.
#'
#' Software distributed under the License is distributed
#' on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
#' express or implied. See the GPL for the specific language
#' governing rights and limitations.
#'
#' You should have received a copy of the GPL along with this
#' program. If not, go to http://www.gnu.org/licenses/gpl.html
#' or write to the Free Software Foundation, Inc.,
#' 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#'
#' The development of this software was supported by the
#' Excellence Cluster EXC 277 Cognitive Interaction Technology.
#' The Excellence Cluster EXC 277 is a grant of the Deutsche
#' Forschungsgemeinschaft (DFG) in the context of the German
#' Excellence Initiative.
#'
#' @description plot a spike train
#' @param spike spike data
#' @param col colour of the spike train
#'
#' @return nothing
#' @export
#'
plot.spiketrain <- function(spike, col = "black", ...) {
	# convenience function for single spike train plotting
	plot(spike, type = "p", ylim = c(0.9, 1.1), axes = FALSE, pch = ".", frame.plot = FALSE, col = col, ...)
	# Axis(side = 1, col = "grey")
}
mruessler/rephys documentation built on May 23, 2019, 7:49 a.m.