Added documentation for the basic transfer function model

2 files changed, 37 insertions, 0 deletions

diff --git a/man/print.tf.Rd b/man/print.tf.Rd
new file mode 100644
index 0000000..cc0ea03
--- /dev/null
+++ b/man/print.tf.Rd
@@ -0,0 +1,15 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tf.R
+\name{print.tf}
+\alias{print.tf}
+\title{Display the Transfer Function}
+\usage{
+\method{print}{tf}(G)
+}
+\arguments{
+\item{G}{an object of class \code{tf}}
+}
+\description{
+Printing method for objects inheriting from class \code{tf}
+}
+
diff --git a/man/tf.Rd b/man/tf.Rd
new file mode 100644
index 0000000..b0055b5
--- /dev/null
+++ b/man/tf.Rd
@@ -0,0 +1,22 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tf.R
+\name{tf}
+\alias{tf}
+\title{S3 class for transfer functions}
+\usage{
+tf(num = c(1), den = c(1), Ts = 1)
+}
+\arguments{
+\item{num}{coefficients of the numerator plynomial in q^{-1}}
+
+\item{den}{coefficients of the denominator plynomial in q^{-1}}
+
+\item{Ts}{sampling time}
+}
+\value{
+an object of class tf
+}
+\description{
+\code{tf} is an S3 class for defining transfer functions.
+}
+