From b9ce44748f2795ae1f35fe5a510e88635f247a7f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 29 Jan 2018 09:22:42 +0100 Subject: Correction of return value documentation for PEC_sw_exposit_runoff Rebuild pkgdown documentation --- docs/reference/PEC_sw_exposit_runoff.html | 17 +++++++-------- docs/reference/PELMO_runs.html | 2 +- docs/reference/TOXSWA_cwa.html | 6 +++--- docs/reference/perc_runoff_reduction_exposit.html | 6 +++--- docs/reference/pesticide.txt | 2 ++ docs/reference/plot.TOXSWA_cwa-10.png | Bin 0 -> 5892 bytes docs/reference/plot.TOXSWA_cwa-2.png | Bin 7786 -> 7826 bytes docs/reference/plot.TOXSWA_cwa-4.png | Bin 0 -> 7575 bytes docs/reference/plot.TOXSWA_cwa-6.png | Bin 0 -> 8021 bytes docs/reference/plot.TOXSWA_cwa-8.png | Bin 0 -> 8094 bytes docs/reference/plot.TOXSWA_cwa.html | 25 +++++++++++++++++----- docs/reference/read.TOXSWA_cwa.html | 6 +++--- 12 files changed, 40 insertions(+), 24 deletions(-) create mode 100644 docs/reference/plot.TOXSWA_cwa-10.png create mode 100644 docs/reference/plot.TOXSWA_cwa-4.png create mode 100644 docs/reference/plot.TOXSWA_cwa-6.png create mode 100644 docs/reference/plot.TOXSWA_cwa-8.png (limited to 'docs') diff --git a/docs/reference/PEC_sw_exposit_runoff.html b/docs/reference/PEC_sw_exposit_runoff.html index 378c4e2..5539dc6 100644 --- a/docs/reference/PEC_sw_exposit_runoff.html +++ b/docs/reference/PEC_sw_exposit_runoff.html @@ -121,9 +121,10 @@ in the worksheet "Konzept Runoff". Calculation of sediment PEC values is not imp

Value

A list containing the following components

-
Input

A matrix containing dissolved and bound input for the different distances

-
PEC_sw_runoo

A matrix containing PEC values for dissolved and bound substance - for the different distances. If the rate was given in g/ha, the PECsw are in /L.

+
perc_runoff

The runoff percentages for dissolved and bound substance

+
runoff

A matrix containing dissolved and bound input for the different distances

+
PEC_sw_runoff

A matrix containing PEC values for dissolved and bound substance + for the different distances. If the rate was given in g/ha, the PECsw are in microg/L.

@@ -133,13 +134,11 @@ in the worksheet "Konzept Runoff". Calculation of sediment PEC values is not imp

Examples

- 
  PEC_sw_exposit_runoff(500, 150)
#> $Rate
-#> [1] 500
+    
  PEC_sw_exposit_runoff(500, 150)
#> $perc_runoff
+#> dissolved     bound 
+#>     0.248     0.001 
 #> 
-#> $Koc
-#> [1] 150
-#> 
-#> $Input
+#> $runoff
 #>           dissolved   bound   total
 #> No buffer     1.240 0.00500 1.24500
 #> 5 m           0.744 0.00300 0.74700
diff --git a/docs/reference/PELMO_runs.html b/docs/reference/PELMO_runs.html
index 9f6b7e8..f06c0fe 100644
--- a/docs/reference/PELMO_runs.html
+++ b/docs/reference/PELMO_runs.html
@@ -190,7 +190,7 @@ the period.plm file generated by the FOCUS PELMO GUI.

 #> 
 #> 
# We get exactly the same PECgw values (on Linux, calling PELMO using Wine).
 print(time_1)
#>        User      System verstrichen 
-#>     218.896       1.000      55.247 

+#>     219.036       1.004      56.622 

 # Demonstrate some results with metabolites.
 runs_2 <- list(list(psm = 'Pesticide_D_1_May_every_other_year_mets',
                     win = c("Cha", "Ham", "Kre")))
diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html
index 908f233..f67df04 100644
--- a/docs/reference/TOXSWA_cwa.html
+++ b/docs/reference/TOXSWA_cwa.html
@@ -92,7 +92,7 @@ Usually, an instance of this class will be generated by 
   
get_events(threshold, total = FALSE)
Populate a datataframe with event information for the specified threshold value
-        in µg/L. If total = TRUE, the total concentration including the amount
-        adsorbed to suspended matter will be used. The resulting dataframe is stored in the 
+        in /L. If total = TRUE, the total concentration including the amount
+        adsorbed to suspended matter will be used. The resulting dataframe is stored in the
         events field of the object.

   
moving_windows(windows, total = FALSE)
Add to the windows field described above.
         Again, if total = TRUE, the total concentration including the amount
diff --git a/docs/reference/perc_runoff_reduction_exposit.html b/docs/reference/perc_runoff_reduction_exposit.html
index d951a9e..59dd40d 100644
--- a/docs/reference/perc_runoff_reduction_exposit.html
+++ b/docs/reference/perc_runoff_reduction_exposit.html
@@ -102,9 +102,9 @@ from which the values were taken.

 #> 20 m             80    95
 #> 
 #> $`2.0`
-#>   dissolved bound
-#> 1       0.0   0.0
-#> 2      97.5  97.5
+#>           dissolved bound
+#> No buffer       0.0   0.0
+#> 20 m           97.5  97.5
 #>

Arguments

@@ -101,6 +102,17 @@ the time is given in days relative to the first of January in the first year.

add + + + + + + + +

Examples

H_sw_D4_pond  <- read.TOXSWA_cwa("00001p_pa.cwa",
-                                 basedir = "SwashProjects/project_H_sw/TOXSWA",
-                                 zipfile = system.file("testdata/SwashProjects.zip",
-                                             package = "pfm"))
-plot(H_sw_D4_pond)
+ basedir="SwashProjects/project_H_sw/TOXSWA", + zipfile=system.file("testdata/SwashProjects.zip", package="pfm")) +plot(H_sw_D4_pond)
plot(H_sw_D4_pond, time_column = "t")
plot(H_sw_D4_pond, time_column = "t_firstjan")
plot(H_sw_D4_pond, time_column = "t_rel_to_max")
+H_sw_R1_stream <- read.TOXSWA_cwa("00003s_pa.cwa", + basedir = "SwashProjects/project_H_sw/TOXSWA", + zipfile = system.file("testdata/SwashProjects.zip", package = "pfm")) +plot(H_sw_R1_stream, time_column = "t_rel_to_max")
- @@ -112,7 +112,7 @@ of interested can be selected by its code name.

- @@ -123,7 +123,7 @@ maximum time weighted average concentrations and areas under the curve.

-

Should we add to an existing plot?
threshold_factor

The factor by which the data have to be lower than the maximum +in order to get thinned for plotting (see next argument).

thin_low

If an integer greater than 1, the data close to zero (smaller than +1/threshold_factor of the maximum) in the series will be thinned by this factor +in order to decrease the amount of data that is included in the plots

total

Should the total concentration in water be plotted, including substance sorbed @@ -119,10 +131,13 @@ to suspended matter?
segment

The segment for which the data should be read. Either "last", or +

The segment for which the data should be read. Either "last", or the segment number.
total

Set this to TRUE in order to read total concentrations as well. This is +

Set this to TRUE in order to read total concentrations as well. This is only necessary for .out files as generated by TOXSWA 4.4.2 or similar, not for .cwa files. For .cwa files, the total concentration is always read as well.
thresholds

Numeric vector of threshold concentrations in µg/L for +

Numeric vector of threshold concentrations in /L for generating event statistics.
-- cgit v1.2.1