aboutsummaryrefslogtreecommitdiff
path: root/man/ppp.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/ppp.Rd')
-rw-r--r--man/ppp.Rd100
1 files changed, 100 insertions, 0 deletions
diff --git a/man/ppp.Rd b/man/ppp.Rd
new file mode 100644
index 0000000..c0d35f1
--- /dev/null
+++ b/man/ppp.Rd
@@ -0,0 +1,100 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/chent.R
+\docType{class}
+\name{ppp}
+\alias{ppp}
+\title{R6 class for a plant protection product with at least one active ingredient}
+\format{
+An \code{\link{R6Class}} generator object.
+}
+\description{
+Contains basic information about the active ingredients in the
+product
+}
+\section{Public fields}{
+\if{html}{\out{<div class="r6-fields">}}
+\describe{
+\item{\code{name}}{The name of the product}
+
+\item{\code{ais}}{A list of active ingredients}
+
+\item{\code{concentrations}}{The concentration of the ais}
+
+\item{\code{concentration_units}}{Defaults to g/L}
+
+\item{\code{density}}{The density of the product}
+
+\item{\code{density_units}}{Defaults to g/L
+Creates a new instance of this \link[R6:R6Class]{R6} class.}
+
+\item{\code{...}}{Identifiers of the active ingredients}
+
+\item{\code{concentrations}}{Concentrations of the active ingredients}
+
+\item{\code{concentration_units}}{Defaults to g/L}
+
+\item{\code{density}}{The density}
+
+\item{\code{density_units}}{Defaults to g/L
+Printing method}
+}
+\if{html}{\out{</div>}}
+}
+\section{Active bindings}{
+\if{html}{\out{<div class="r6-active-bindings">}}
+\describe{
+\item{\code{...}}{Identifiers of the active ingredients}
+}
+\if{html}{\out{</div>}}
+}
+\section{Methods}{
+\subsection{Public methods}{
+\itemize{
+\item \href{#method-ppp-new}{\code{ppp$new()}}
+\item \href{#method-ppp-print}{\code{ppp$print()}}
+\item \href{#method-ppp-clone}{\code{ppp$clone()}}
+}
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-ppp-new"></a>}}
+\if{latex}{\out{\hypertarget{method-ppp-new}{}}}
+\subsection{Method \code{new()}}{
+\subsection{Usage}{
+\if{html}{\out{<div class="r">}}\preformatted{ppp$new(
+ name,
+ ...,
+ concentrations,
+ concentration_units = "g/L",
+ density = 1000,
+ density_units = "g/L"
+)}\if{html}{\out{</div>}}
+}
+
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-ppp-print"></a>}}
+\if{latex}{\out{\hypertarget{method-ppp-print}{}}}
+\subsection{Method \code{print()}}{
+\subsection{Usage}{
+\if{html}{\out{<div class="r">}}\preformatted{ppp$print()}\if{html}{\out{</div>}}
+}
+
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-ppp-clone"></a>}}
+\if{latex}{\out{\hypertarget{method-ppp-clone}{}}}
+\subsection{Method \code{clone()}}{
+The objects of this class are cloneable with this method.
+\subsection{Usage}{
+\if{html}{\out{<div class="r">}}\preformatted{ppp$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>}}
+}
+}
+}

Contact - Imprint