summaryrefslogtreecommitdiff
path: root/man/ppp.Rd
blob: 9942b361349a3899416f75035120c2e75d1f1008 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/chent.R
\name{ppp}
\alias{ppp}
\title{R6 class for a plant protection product with at least one active ingredient}
\format{
An \link[R6:R6Class]{R6::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}
  }
  \if{html}{\out{</div>}}
}
\section{Methods}{
\subsection{Public methods}{
  \itemize{
    \item \href{#method-ppp-initialize}{\code{ppp$new()}}
    \item \href{#method-ppp-clone}{\code{ppp$clone()}}
  }
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-ppp-initialize"></a>}}
\if{latex}{\out{\hypertarget{method-ppp-initialize}{}}}
\subsection{\code{ppp$new()}}{
  Creates a new instance of this \link[R6:R6Class]{R6} class.
  \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>}}
  }
  \subsection{Arguments}{
    \if{html}{\out{<div class="arguments">}}
    \describe{
      \item{\code{name}}{The name of the product}
      \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}
    }
    \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{\code{ppp$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