From 816de01ce642c1c3d633ffb1cbcf960036d27114 Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Fri, 10 Nov 2023 18:40:34 +0100 Subject: Make an RStudio project and improve the docs --- docs/reference/pp.html | 208 +++++++++++++++++++------------------------------ 1 file changed, 78 insertions(+), 130 deletions(-) (limited to 'docs/reference/pp.html') diff --git a/docs/reference/pp.html b/docs/reference/pp.html index c4e4a01..2607035 100644 --- a/docs/reference/pp.html +++ b/docs/reference/pp.html @@ -1,67 +1,12 @@ - - - - - - - -R6 class for holding a product with at least one active ingredient — pp • chents - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R6 class for holding a product with at least one active ingredient — pp • chents - - - - + + -
-
- -
- -
+

R6 class for holding a product with at least one active ingredient

- Source: R/chent.R + Source: R/chent.R
@@ -118,89 +50,105 @@
+
+

Format

+

An R6Class generator object.

+
+
+

Public fields

+

name
+

The name of the product

-

Format

-

An R6Class generator object.

-

Public fields

+
ais
+

A list of active ingredients

-

-
name

The name of the product

-
ais

A list of active ingredients

+
concentrations
+

The concentration of the ais

-
concentrations

The concentration of the ais

-
concentration_units

Defaults to g/L

+
concentration_units
+

Defaults to g/L

-

-

Methods

+

+
+
+

Methods

-

Public methods

+
+

Public methods

+ +

+

Method new()

+ +
+

Usage

+

pp$new(
+  name,
+  ...,
+  concentrations,
+  concentration_units = "g/L",
+  density = 1000,
+  density_units = "g/L"
+)

+
- -

-

Method new()

-

Usage

-

pp$new(
-  name,
-  ...,
-  concentrations,
-  concentration_units = "g/L",
-  density = 1000,
-  density_units = "g/L"
-)

+

+

Method print()

-

-

Method print()

+
+

Usage

+

pp$print()

+
-

Usage

-

pp$print()

-

-

Method clone()

-

The objects of this class are cloneable with this method.

Usage

-

pp$clone(deep = FALSE)

+

+

Method clone()

+

The objects of this class are cloneable with this method.

+

Usage

+

pp$clone(deep = FALSE)

+
+ +
+

Arguments

+

deep
+

Whether to make a deep clone.

-

Arguments

-

-
deep

Whether to make a deep clone.

-

+

+
+
+
+
- - - + + -- cgit v1.2.1