diff options
| -rw-r--r-- | R/ioNamesData.R | 27 | ||||
| -rw-r--r-- | man/inputData.Rd | 20 | ||||
| -rw-r--r-- | man/inputNames.Rd | 22 | ||||
| -rw-r--r-- | man/nInputSeries.Rd | 16 |
4 files changed, 85 insertions, 0 deletions
diff --git a/R/ioNamesData.R b/R/ioNamesData.R index e951cc3..823c6b0 100644 --- a/R/ioNamesData.R +++ b/R/ioNamesData.R @@ -1,3 +1,12 @@ +#' Number of series in input or output +#' +#' Number of series in input or output in a idframe object +#' +#' +#' @param data \code{idframe} object +#' +#' @aliases nOutputSeries +#' #' @export nInputSeries <- function(data) { ifelse(is.null(data$input),0,ncol(data$input)) @@ -6,6 +15,15 @@ nInputSeries <- function(data) { #' @export nOutputSeries <- function(data) ncol(data$output) +#' Output or Input-data +#' +#' Extract output-data or input-data in idframe objects +#' +#' @param x \code{idframe} object +#' @param series the indices to extract +#' +#' @aliases inputData.idframe outputData outputData.idframe +#' #' @export inputData <- function(x,series) UseMethod("inputData") @@ -29,6 +47,15 @@ inputData.idframe <- function(x,series=seq(nInputSeries(x))){ x } +#' Extract or set series' names +#' +#' Extract or set names of series in input or output +#' +#' @param x \code{idframe} object +#' @param value vector of strings +#' +#' @aliases inputNames<- inputNames<-.idframe outputNames outputNames outputNames<- outputNames<-.idframe +#' #' @export inputNames <- function(x) UseMethod("inputNames") diff --git a/man/inputData.Rd b/man/inputData.Rd new file mode 100644 index 0000000..5164aa8 --- /dev/null +++ b/man/inputData.Rd @@ -0,0 +1,20 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/ioNamesData.R +\name{inputData} +\alias{inputData} +\alias{inputData.idframe} +\alias{outputData} +\alias{outputData.idframe} +\title{Output or Input-data} +\usage{ +inputData(x, series) +} +\arguments{ +\item{x}{\code{idframe} object} + +\item{series}{the indices to extract} +} +\description{ +Extract output-data or input-data in idframe objects +} + diff --git a/man/inputNames.Rd b/man/inputNames.Rd new file mode 100644 index 0000000..5e45d35 --- /dev/null +++ b/man/inputNames.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/ioNamesData.R +\name{inputNames} +\alias{inputNames} +\alias{inputNames<-} +\alias{inputNames<-.idframe} +\alias{outputNames} +\alias{outputNames<-} +\alias{outputNames<-.idframe} +\title{Extract or set series' names} +\usage{ +inputNames(x) +} +\arguments{ +\item{x}{\code{idframe} object} + +\item{value}{vector of strings} +} +\description{ +Extract or set names of series in input or output +} + diff --git a/man/nInputSeries.Rd b/man/nInputSeries.Rd new file mode 100644 index 0000000..7f7feed --- /dev/null +++ b/man/nInputSeries.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/ioNamesData.R +\name{nInputSeries} +\alias{nInputSeries} +\alias{nOutputSeries} +\title{Number of series in input or output} +\usage{ +nInputSeries(data) +} +\arguments{ +\item{data}{\code{idframe} object} +} +\description{ +Number of series in input or output in a idframe object +} + |