From 7e15d589cb18d233b20e78503024cff4a0387855 Mon Sep 17 00:00:00 2001 From: Suraj Yerramilli Date: Fri, 6 Jan 2017 14:32:12 -0600 Subject: final stages of documentation --- R/ioNamesData.R | 19 ++++++++++--------- R/util.R | 11 +++++++---- man/grapes-equals-grapes.Rd | 8 ++++++-- man/inputNames-set.Rd | 22 ++++++++++++++++++++++ man/inputNames.Rd | 22 ---------------------- 5 files changed, 45 insertions(+), 37 deletions(-) create mode 100644 man/inputNames-set.Rd delete mode 100644 man/inputNames.Rd diff --git a/R/ioNamesData.R b/R/ioNamesData.R index 823c6b0..f28f7ae 100644 --- a/R/ioNamesData.R +++ b/R/ioNamesData.R @@ -47,15 +47,7 @@ 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") @@ -70,6 +62,15 @@ inputNames.idframe <- function(x){ seriesNames(inputData(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,value) UseMethod("inputNames<-") diff --git a/R/util.R b/R/util.R index bf92808..f58c3fb 100644 --- a/R/util.R +++ b/R/util.R @@ -3,15 +3,18 @@ #' #' Assign multiple variables from a list or function return object #' -#' @param l,r the variables to be assigned, and the list or -#' function return object +#' @param l the variables to be assigned +#' @param r the list or function-return object +#' @param \ldots other arguments +#' +#' @aliases g #' #' @export -'%=%' = function(l, r, ...) UseMethod('%=%') +'%=%' = function(l,r,...) UseMethod('%=%') # Binary Operator #' @export -'%=%.lbunch' = function(l, r, ...) { +'%=%.lbunch' = function(l,r,...) { Envir = as.environment(-1) # if (length(r) > length(l)) diff --git a/man/grapes-equals-grapes.Rd b/man/grapes-equals-grapes.Rd index b707b0a..c0097a7 100644 --- a/man/grapes-equals-grapes.Rd +++ b/man/grapes-equals-grapes.Rd @@ -2,13 +2,17 @@ % Please edit documentation in R/util.R \name{\%=\%} \alias{\%=\%} +\alias{g} \title{Multiple assignment operator} \usage{ l \%=\% r } \arguments{ -\item{l, r}{the variables to be assigned, and the list or -function return object} +\item{l}{the variables to be assigned} + +\item{r}{the list or function-return object} + +\item{\ldots}{other arguments} } \description{ Assign multiple variables from a list or function return object diff --git a/man/inputNames-set.Rd b/man/inputNames-set.Rd new file mode 100644 index 0000000..7584a55 --- /dev/null +++ b/man/inputNames-set.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) <- value +} +\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/inputNames.Rd b/man/inputNames.Rd deleted file mode 100644 index 5e45d35..0000000 --- a/man/inputNames.Rd +++ /dev/null @@ -1,22 +0,0 @@ -% 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 -} - -- cgit