diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2020-03-30 19:17:13 +0200 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2020-03-30 19:17:13 +0200 |
commit | cfa1340c41fe77117c3c2481ddbb25579f196bdd (patch) | |
tree | 51bbf02b2b1db180c9eea1c9559ba0b7b538b5f8 /man/mkinds.Rd | |
parent | 68eed166cbe10a5ee79f5b1139261dea98234b22 (diff) |
Don't check for gcc on the path in mkinmod
Roxygen update -> formatting changes in Rd files
Diffstat (limited to 'man/mkinds.Rd')
-rw-r--r-- | man/mkinds.Rd | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/man/mkinds.Rd b/man/mkinds.Rd index 0ea562ed..79eb0167 100644 --- a/man/mkinds.Rd +++ b/man/mkinds.Rd @@ -5,9 +5,6 @@ \alias{mkinds} \title{A dataset class for mkin} \format{An \code{\link{R6Class}} generator object.} -\usage{ -mkinds -} \description{ A dataset class for mkin } @@ -36,3 +33,35 @@ mds <- mkinds$new("FOCUS A", FOCUS_2006_A) } \keyword{datasets} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-new}{\code{mkinds$new()}} +\item \href{#method-clone}{\code{mkinds$clone()}} +} +} +\if{html}{\out{<hr>}} +\if{html}{\out{<a id="method-new"></a>}} +\subsection{Method \code{new()}}{ +\subsection{Usage}{ +\if{html}{\out{<div class="r">}}\preformatted{mkinds$new(title = "", data, time_unit = NA, unit = NA)}\if{html}{\out{</div>}} +} + +} +\if{html}{\out{<hr>}} +\if{html}{\out{<a id="method-clone"></a>}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{<div class="r">}}\preformatted{mkinds$clone(deep = FALSE)}\if{html}{\out{</div>}} +} + +\subsection{Arguments}{ +\if{html}{\out{<div class="arguments">}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{</div>}} +} +} +} |