From bf535e05f09864d5a88591d55bb8993b0619e57a Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Sat, 11 Nov 2023 08:23:28 +0100 Subject: Start new version, rename pp to ppp, more docs --- docs/404.html | 2 +- docs/authors.html | 6 +- docs/index.html | 2 +- docs/pkgdown.yml | 2 +- docs/reference/chent.html | 319 ++++++++++++++++++++++++++++++++++++- docs/reference/draw_svg.chent.html | 2 +- docs/reference/index.html | 6 +- docs/reference/pai.html | 43 +++-- docs/reference/plot.chent.html | 2 +- docs/reference/ppp.html | 194 ++++++++++++++++++++++ docs/reference/print.chent.html | 2 +- docs/reference/print.pai.html | 2 +- docs/sitemap.xml | 3 + 13 files changed, 555 insertions(+), 30 deletions(-) create mode 100644 docs/reference/ppp.html (limited to 'docs') diff --git a/docs/404.html b/docs/404.html index eb79a5d..26a509c 100644 --- a/docs/404.html +++ b/docs/404.html @@ -32,7 +32,7 @@ chents - 0.3.1 + 0.3.2 diff --git a/docs/authors.html b/docs/authors.html index 0c3b654..1e764a7 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -17,7 +17,7 @@ chents - 0.3.1 + 0.3.2 @@ -60,13 +60,13 @@

Ranke J (2023). chents: Chemical Entities as R Objects. -R package version 0.3.1, https://github.com/jranke/chents. +R package version 0.3.2, https://github.com/jranke/chents. 

@Manual{,
   title = {chents: Chemical Entities as R Objects},
   author = {Johannes Ranke},
   year = {2023},
-  note = {R package version 0.3.1},
+  note = {R package version 0.3.2},
   url = {https://github.com/jranke/chents},
 }
diff --git a/docs/index.html b/docs/index.html index f241bb6..313ff06 100644 --- a/docs/index.html +++ b/docs/index.html @@ -37,7 +37,7 @@ chents - 0.3.1 + 0.3.2 diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index dd7c4f0..eb77ea1 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 3.1.1 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-11-10T17:41Z +last_built: 2023-11-11T07:23Z diff --git a/docs/reference/chent.html b/docs/reference/chent.html index a6b8dde..48ccf3f 100644 --- a/docs/reference/chent.html +++ b/docs/reference/chent.html @@ -19,7 +19,7 @@ generated using RDKit if RDKit and its python bindings are installed.">An R6 class for pesticidal active ingredients and associated data — pai • chentsAn R6 class for pesticidal active ingredients and associated data — pai • chents @@ -18,7 +18,7 @@ Additional chemical information is retrieved from the internet if available."> chents - 0.3.1 + 0.3.2 @@ -47,14 +47,19 @@ Additional chemical information is retrieved from the internet if available.">
-

The class is initialised with an identifier which is generally an ISO common name. -Additional chemical information is retrieved from the internet if available.

+

An R6 class for pesticidal active ingredients and associated data

+

An R6 class for pesticidal active ingredients and associated data

Format

An R6Class generator object

+
+
+

Details

+

The class is initialised with an identifier which is generally an ISO common name. +Additional chemical information is retrieved from the internet if available.

Super class

@@ -63,11 +68,13 @@ Additional chemical information is retrieved from the internet if available.

Public fields

iso
-

ISO common name according to ISO 1750 as retreived from pesticidecompendium.bcpc.org

+

ISO common name of the active ingredient according to ISO 1750

bcpc
-

List of information retrieved from pesticidecompendium.bcpc.org

+

Information retrieved from the BCPC compendium available online +at <pesticidecompendium.bcpc.org> +Creates a new instance of this R6 class.

@@ -97,8 +104,11 @@ Additional chemical information is retrieved from the internet if available.

  • chents::chent$try_pubchem()

    • Method new()

    - -
    +

    This class is derived from chent. It makes it easy +to create a chent from the ISO common name of a pesticide active +ingredient, and additionally stores the ISO name as well as +the complete result of querying the BCPC compendium using +bcpc_query.

    Usage

    pai$new(
   iso,
@@ -114,6 +124,19 @@ Additional chemical information is retrieved from the internet if available.
    
 )

    +
    +

    Arguments

    +

    iso
    +

    The ISO common name to be used in the query of the +BCPC compendium

    + + +
    identifier
    +

    Alternative identifier used for querying pubchem

    + + +

    +

    Method clone()

    @@ -123,7 +146,7 @@ Additional chemical information is retrieved from the internet if available.

    -

    Arguments

    +

    Arguments

    deep

    Whether to make a deep clone.

    diff --git a/docs/reference/plot.chent.html b/docs/reference/plot.chent.html index 470ce79..26d8445 100644 --- a/docs/reference/plot.chent.html +++ b/docs/reference/plot.chent.html @@ -17,7 +17,7 @@ chents - 0.3.1 + 0.3.2
    diff --git a/docs/reference/ppp.html b/docs/reference/ppp.html new file mode 100644 index 0000000..7a9b861 --- /dev/null +++ b/docs/reference/ppp.html @@ -0,0 +1,194 @@ + +R6 class for a plant protection product with at least one active ingredient — ppp • chents + + +
    +
    + + + +
    +
    +
    +

    R6 class for a plant protection product with at least one active ingredient

    + Source: R/chent.R + +
    + +
    +

    Contains basic information about the active ingredients in the +product

    +
    + + +
    +

    Format

    +

    An R6Class generator object.

    +
    +
    +

    Public fields

    +

    name
    +

    The name of the product

    + + +
    ais
    +

    A list of active ingredients

    + + +
    concentrations
    +

    The concentration of the ais

    + + +
    concentration_units
    +

    Defaults to g/L

    + + +
    density
    +

    The density of the product

    + + +
    density_units
    +

    Defaults to g/L +Creates a new instance of this R6 class.

    + + +
    ...
    +

    Identifiers of the active ingredients

    + + +
    concentrations
    +

    Concentrations of the active ingredients

    + + +
    concentration_units
    +

    Defaults to g/L

    + + +
    density
    +

    The density

    + + +
    density_units
    +

    Defaults to g/L +Printing method

    + + +

    +
    +
    +

    Active bindings

    +

    ...
    +

    Identifiers of the active ingredients

    + + +

    +
    +
    +

    Methods

    + +
    +

    Public methods

    + +

    +

    Method new()

    + +
    +

    Usage

    +

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

    +
    + + +

    +

    Method print()

    + +
    +

    Usage

    +

    ppp$print()

    +
    + + +

    +

    Method clone()

    +

    The objects of this class are cloneable with this method.

    +

    Usage

    +

    ppp$clone(deep = FALSE)

    +
    + +
    +

    Arguments

    +

    deep
    +

    Whether to make a deep clone.

    + + +

    +
    + +
    + +
    + +
    + +
    + + +
    +

    Developed by Johannes Ranke.

    +
    + +
    +

    Site built with pkgdown 2.0.7.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/print.chent.html b/docs/reference/print.chent.html index 08497dd..da3ba4f 100644 --- a/docs/reference/print.chent.html +++ b/docs/reference/print.chent.html @@ -17,7 +17,7 @@ chents - 0.3.1 + 0.3.2
    diff --git a/docs/reference/print.pai.html b/docs/reference/print.pai.html index 3faa5f7..5a08066 100644 --- a/docs/reference/print.pai.html +++ b/docs/reference/print.pai.html @@ -17,7 +17,7 @@ chents - 0.3.1 + 0.3.2
    diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 986ccf3..63ab18d 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -27,6 +27,9 @@ /reference/pp.html + + /reference/ppp.html + /reference/print.chent.html -- cgit v1.2.1