diff --git a/NAMESPACE b/NAMESPACE index a31c701..5f56d16 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,7 +1,6 @@ # Generated by roxygen2: do not edit by hand S3method(plot,eyeris) -export(baseline) export(bidsify) export(deblink) export(despeed) @@ -10,5 +9,4 @@ export(epoch) export(interpolate) export(load) export(lpfilt) -export(pca) export(zscore) diff --git a/R/baseline.R b/R/baseline.R index ab71dcb..fd10c98 100644 --- a/R/baseline.R +++ b/R/baseline.R @@ -1,14 +1,11 @@ -#' The length of a string -#' +#' Subtractive / divisive baselining of pupil data +#' #' todo: description goes here... #' #' @param eyeris An object of class `eyeris` dervived from [eyeris::load()]. #' #' @return A numeric vector giving number of characters (code points) in each #' element of the character vector. Missing string have missing length. -#' @export -#' @examples -#' str_length(letters) -baseline <- function(eyeris, extend = 0) { +baseline <- function(eyeris) { ## TODO } \ No newline at end of file diff --git a/R/pca.R b/R/tpca.R similarity index 74% rename from R/pca.R rename to R/tpca.R index 8f6515c..6e97c70 100644 --- a/R/pca.R +++ b/R/tpca.R @@ -1,4 +1,4 @@ -#' The length of a string +#' Temporal PCA #' #' todo: description goes here... #' @@ -6,9 +6,6 @@ #' #' @return A numeric vector giving number of characters (code points) in each #' element of the character vector. Missing string have missing length. -#' @export -#' @examples -#' str_length(letters) -pca <- function(eyeris) { +tpca <- function(eyeris) { ## TODO } diff --git a/man/baseline.Rd b/man/baseline.Rd index c7dc282..53c5f76 100644 --- a/man/baseline.Rd +++ b/man/baseline.Rd @@ -2,9 +2,9 @@ % Please edit documentation in R/baseline.R \name{baseline} \alias{baseline} -\title{The length of a string} +\title{Subtractive / divisive baselining of pupil data} \usage{ -baseline(eyeris, extend = 0) +baseline(eyeris) } \arguments{ \item{eyeris}{An object of class \code{eyeris} dervived from \code{\link[=load]{load()}}.} @@ -16,6 +16,3 @@ element of the character vector. Missing string have missing length. \description{ todo: description goes here... } -\examples{ -str_length(letters) -} diff --git a/man/pca.Rd b/man/tpca.Rd similarity index 71% rename from man/pca.Rd rename to man/tpca.Rd index 5601f9a..8c0ebb6 100644 --- a/man/pca.Rd +++ b/man/tpca.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/pca.R -\name{pca} -\alias{pca} -\title{The length of a string} +% Please edit documentation in R/tpca.R +\name{tpca} +\alias{tpca} +\title{Temporal PCA} \usage{ -pca(eyeris) +tpca(eyeris) } \arguments{ \item{eyeris}{An object of class \code{eyeris} dervived from \code{\link[=load]{load()}}.} @@ -16,6 +16,3 @@ element of the character vector. Missing string have missing length. \description{ todo: description goes here... } -\examples{ -str_length(letters) -}