From d97e57a36e6b76def7a980fa6a06b2827df39c3e Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 2 Dec 2024 09:20:54 +0100 Subject: Add @description tags to R6 methods Otherwise, the descriptions of the methods get mixed up --- docs/reference/chent.html | 69 ++++++++++++++++------------------------------- docs/reference/pai.html | 3 +-- docs/reference/ppp.html | 6 ++--- 3 files changed, 26 insertions(+), 52 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/chent.html b/docs/reference/chent.html index cef2061..aed63b3 100644 --- a/docs/reference/chent.html +++ b/docs/reference/chent.html @@ -116,18 +116,15 @@ List of information retrieved from PubChem

TPs
-

List of transformation products as chent objects -Add a transformation product to the internal list

+

List of transformation products as chent objects

transformations
-

Data frame of observed transformations -Add a line in the internal dataframe holding observed transformations

+

Data frame of observed transformations

soil_degradation
-

Dataframe of modelling DT50 values -Add a line in the internal dataframe holding modelling DT50 values

+

Dataframe of modelling DT50 values

soil_ff
@@ -135,8 +132,7 @@ Add a line in the internal dataframe holding modelling DT50 values

soil_sorption
-

Dataframe of soil sorption data -Add soil sorption data

+

Dataframe of soil sorption data

@@ -166,8 +162,7 @@ Add soil sorption data

  • chent$clone()

    • Method new()

    -

    Creates a new instance of this R6 class.

    -

    Try to get chemical information from PubChem

    +

    Creates a new instance of this R6 class.

    Usage

    chent$new(
   identifier,
@@ -225,8 +220,7 @@ directory?

    Method try_pubchem()

    - -
    +

    Try to get chemical information from PubChem

    Usage

    chent$try_pubchem(query, from = "name")

    @@ -238,8 +232,7 @@ directory?

    from
    -

    Passed to get_cid -Get chemical information from PubChem for a known PubChem CID

    +

    Passed to get_cid

    @@ -247,8 +240,7 @@ Get chemical information from PubChem for a known PubChem CID

    Method get_pubchem()

    - -
    +

    Get chemical information from PubChem for a known PubChem CID

    Usage

    chent$get_pubchem(pubchem_cid)

    @@ -264,8 +256,7 @@ Get chemical information from PubChem for a known PubChem CID

    Method get_rdkit()

    -

    Get chemical information from RDKit if available -Obtain information from a YAML file

    +

    Get chemical information from RDKit if available

    Usage

    chent$get_rdkit(template = NULL)

    @@ -281,8 +272,7 @@ Obtain information from a YAML file

    Method get_chyaml()

    - -
    +

    Obtain information from a YAML file

    Usage

    chent$get_chyaml(
   repo = c("wd", "local", "web"),
@@ -299,8 +289,7 @@ the web (not implemented).
    
 
 
 
    chyaml
    
-
    The filename to be looked for
-Add a vapour pressure
    
+
    The filename to be looked for
    @@ -308,8 +297,7 @@ Add a vapour pressure

    Method add_p0()

    - -
    +

    Add a vapour pressure

    Usage

    chent$add_p0(p0, T = NA, source = NA, page = NA, remark = "")

    @@ -317,8 +305,7 @@ Add a vapour pressure

    Arguments

    p0
    -

    The vapour pressure in Pa -Add a water solubility

    +

    The vapour pressure in Pa

    T
    @@ -342,8 +329,7 @@ Add a water solubility

    Method add_cwsat()

    - -
    +

    Add a water solubility

    Usage

    chent$add_cwsat(cwsat, T = NA, pH = NA, source = NA, page = NA, remark = "")

    @@ -351,8 +337,7 @@ Add a water solubility

    Arguments

    cwsat
    -

    The water solubility in mg/L -Add a plant uptake factor

    +

    The water solubility in mg/L

    T
    @@ -380,8 +365,7 @@ Add a plant uptake factor

    Method add_PUF()

    - -
    +

    Add a plant uptake factor

    Usage

    chent$add_PUF(
   PUF = 0,
@@ -414,8 +398,7 @@ Add a plant uptake factor

    Method add_TP()

    - -
    +

    Add a transformation product to the internal list

    Usage

    chent$add_TP(x, smiles = NULL, pubchem = FALSE)

    @@ -439,8 +422,7 @@ Add a plant uptake factor

    Method add_transformation()

    - -
    +

    Add a line in the internal dataframe holding observed transformations

    Usage

    chent$add_transformation(
   study_type,
@@ -486,8 +468,7 @@ result from stochiometric transformation

    Method add_soil_degradation()

    - -
    +

    Add a line in the internal dataframe holding modelling DT50 values

    Usage

    chent$add_soil_degradation(
   soils,
@@ -593,8 +574,7 @@ the technical active ingredient

    Method add_soil_ff()

    - -
    +

    Add one or more formation fractions for degradation in soil

    Usage

    chent$add_soil_ff(target, soils, ff = 1, remark = "", source, page = NA)

    @@ -630,8 +610,7 @@ the technical active ingredient

    Method add_soil_sorption()

    - -
    +

    Add soil sorption data

    Usage

    chent$add_soil_sorption(
   soils,
@@ -715,8 +694,7 @@ or according to Freundlich

    Method pdf()

    -

    Write a PDF image of the structure -Write a PNG image of the structure

    +

    Write a PDF image of the structure

    Usage

    chent$pdf(
   file = paste0(self$identifier, ".pdf"),
@@ -744,8 +722,7 @@ Write a PNG image of the structure
    
 
 
    
 
    Method png()
    
-
-
    
+
    Write a PNG image of the structure
    
 
    Usage
    
 
    chent$png(
   file = paste0(self$identifier, ".png"),
diff --git a/docs/reference/pai.html b/docs/reference/pai.html
index 30bbbac..b24c78e 100644
--- a/docs/reference/pai.html
+++ b/docs/reference/pai.html
@@ -96,8 +96,7 @@ at <pesticidecompendium.bcpc.org>
    
 
  • chents::chent$try_pubchem()
    • 
 
    
 
    Method new()
    
-
-
    
+
    Create a new pai object
    
 
    Usage
    
 
    pai$new(
   iso,
diff --git a/docs/reference/ppp.html b/docs/reference/ppp.html
index ef3933d..f7b7705 100644
--- a/docs/reference/ppp.html
+++ b/docs/reference/ppp.html
@@ -68,8 +68,7 @@ product
    
 
 
 
    density_units
    
-
    Defaults to g/L
-Creates a new instance of this R6 class.
    
+
    Defaults to g/L
    
 
 
 
    
@@ -84,8 +83,7 @@ Creates a new instance of this ppp$clone()
    
 
    
 
    Method new()
    
-
-
    
+
    Creates a new instance of this R6 class.
    
 
    Usage
    
 
    ppp$new(
   name,
-- 
cgit v1.2.1