Minor documentation

4 files changed, 36 insertions, 0 deletions

diff --git a/R/idframe.R b/R/idframe.R
index 3026d55..c666b55 100644
--- a/R/idframe.R
+++ b/R/idframe.R
@@ -108,6 +108,15 @@ print.summary.idframe <- function(x,...){
   print(x$in_sum)
 }
 
+#' Sampling times of IO data
+#'  
+#' \code{time} creates the vector of times at which data was sampled. \code{frequency} returns the number of damples per unit time and \code{deltat} the time-interval 
+#' between observations
+#'  
+#' @param x a idframe object, or a univariate or multivariate time-series, or a vector or matrix
+#'  
+#' @aliases frequency deltat
+#'  
 #' @export
 time <- function(x){
   if(class(x)[1]!="idframe"){
diff --git a/R/preprocess.R b/R/preprocess.R
index 27aaf0c..b5ba991 100644
--- a/R/preprocess.R
+++ b/R/preprocess.R
@@ -13,10 +13,13 @@
 #' A list containing two objects: the detrended data and the trend information
 #' 
 #' @details 
+#' 
 #' \code{R} by default doesn't allow return of multiple objects. The \code{\%=\%}
 #' operator and \code{g} function in this package facillitate this behaviour. See 
 #' the examples section for more information.
 #' 
+#' @aliases trInfo
+#' 
 #' @examples
 #' data(cstr)
 #' datatrain <- dataSlice(cstr,end=4500)
diff --git a/man/detrend.Rd b/man/detrend.Rd
index 62b71ab..2303b5b 100644
--- a/man/detrend.Rd
+++ b/man/detrend.Rd
@@ -2,6 +2,7 @@
 % Please edit documentation in R/preprocess.R
 \name{detrend}
 \alias{detrend}
+\alias{trInfo}
 \title{Remove offsets and linear trends}
 \usage{
 detrend(x, type = 0)
diff --git a/man/time.Rd b/man/time.Rd
new file mode 100644
index 0000000..91ba6c6
--- /dev/null
+++ b/man/time.Rd
@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/idframe.R
+\name{time}
+\alias{deltat}
+\alias{frequency}
+\alias{time}
+\title{Sampling times of IO data
+ 
+\code{time} creates the vector of times at which data was sampled. \code{frequency} returns the number of damples per unit time and \code{deltat} the time-interval 
+between observations}
+\usage{
+time(x)
+}
+\arguments{
+\item{x}{a idframe object, or a univariate or multivariate time-series, or a vector or matrix}
+}
+\description{
+Sampling times of IO data
+ 
+\code{time} creates the vector of times at which data was sampled. \code{frequency} returns the number of damples per unit time and \code{deltat} the time-interval 
+between observations
+}
+