diff options
author | Suraj Yerramilli | 2015-02-02 18:08:26 +0530 |
---|---|---|
committer | Suraj Yerramilli | 2015-02-02 18:08:26 +0530 |
commit | 2e9536e308d6d82c7a7b9cbaa63efb76e3d1037f (patch) | |
tree | 9b747b912faa40ae735ef141cc9aadf3b25a1ed5 | |
parent | b8d13d5183148e08c6441230ea4106f314f15657 (diff) | |
download | SysID-R-code-2e9536e308d6d82c7a7b9cbaa63efb76e3d1037f.tar.gz SysID-R-code-2e9536e308d6d82c7a7b9cbaa63efb76e3d1037f.tar.bz2 SysID-R-code-2e9536e308d6d82c7a7b9cbaa63efb76e3d1037f.zip |
Modified the documentation
-rw-r--r-- | R/idframe.R | 2 | ||||
-rw-r--r-- | man/idframe.Rd | 2 | ||||
-rw-r--r-- | man/sysid-package.Rd | 41 | ||||
-rw-r--r-- | sysid.Rproj | 2 |
4 files changed, 3 insertions, 44 deletions
diff --git a/R/idframe.R b/R/idframe.R index 15752da..239d37e 100644 --- a/R/idframe.R +++ b/R/idframe.R @@ -1,6 +1,6 @@ #' S3 class for storing input-output data. #' -#' \code{idframe} is an S3 class for storisupports discrete time and frequency domain data. +#' \code{idframe} is an S3 class for storing and manipulating input-ouput data. It supports discrete time and frequency domain data. #' #' @param output dataframe/matrix/vector containing the outputs #' @param input dataframe/matrix/vector containing the inputs diff --git a/man/idframe.Rd b/man/idframe.Rd index 76065f4..c9d8e7b 100644 --- a/man/idframe.Rd +++ b/man/idframe.Rd @@ -32,6 +32,6 @@ recorded (Valid only if type="frequency")} an idframe object } \description{ -\code{idframe} is an S3 class for storisupports discrete time and frequency domain data. +\code{idframe} is an S3 class for storing and manipulating input-ouput data. It supports discrete time and frequency domain data. } diff --git a/man/sysid-package.Rd b/man/sysid-package.Rd deleted file mode 100644 index 48648a3..0000000 --- a/man/sysid-package.Rd +++ /dev/null @@ -1,41 +0,0 @@ -\name{sysid-package} -\alias{sysid-package} -\alias{sysid} -\docType{package} -\title{ -What the package does (short line) -~~ package title ~~ -} -\description{ -More about what it does (maybe more than one line) -~~ A concise (1-5 lines) description of the package ~~ -} -\details{ -\tabular{ll}{ -Package: \tab sysid\cr -Type: \tab Package\cr -Version: \tab 1.0\cr -Date: \tab 2015-01-17\cr -License: \tab What license is it under?\cr -} -~~ An overview of how to use the package, including the most important functions ~~ -} -\author{ -Who wrote it - -Maintainer: Who to complain to <yourfault@somewhere.net> -~~ The author and/or maintainer of the package ~~ -} -\references{ -~~ Literature or other references for background information ~~ -} -~~ Optionally other standard keywords, one per line, from file KEYWORDS in the R ~~ -~~ documentation directory ~~ -\keyword{ package } -\seealso{ -~~ Optional links to other man pages, e.g. ~~ -~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~ -} -\examples{ -~~ simple examples of the most important functions ~~ -} diff --git a/sysid.Rproj b/sysid.Rproj index 559f1b4..80d8398 100644 --- a/sysid.Rproj +++ b/sysid.Rproj @@ -15,5 +15,5 @@ LaTeX: pdfLaTeX BuildType: Package PackageUseDevtools: Yes PackageInstallArgs: --no-multiarch --with-keep.source -PackageBuildArgs: Rd2pdf sysid +PackageBuildBinaryArgs: --latex PackageRoxygenize: rd |