From 282820693c62b958e12104f4bb6229c04803f098 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 1 Mar 2018 10:32:08 +0100 Subject: Add a README.html for cgit.jrwb.de --- .Rbuildignore | 3 - ChangeLog | 9 +++ DESCRIPTION | 2 +- GNUmakefile | 20 ++++--- README.html | 176 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 198 insertions(+), 12 deletions(-) create mode 100644 README.html diff --git a/.Rbuildignore b/.Rbuildignore index 01a3edc..cbcae93 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,9 +1,6 @@ ^pfm_.*.tar.gz ^pfm_.*.zip ^GNUmakefile$ -^README.rmd$ -^00003s_pa.cwa$ -^README_files$ ^README.html$ ^build.log$ ^test.log$ diff --git a/ChangeLog b/ChangeLog index ea7b134..c715b62 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +commit 6d8de73e68f2c0349e618af35ce4a8f095ca0ed5 +Author: Johannes Ranke +Date: 2018-03-01 10:10:08 +0100 + + Rebuild static docs using current pkdown + + Process PELMO runs in example using 15 (hyperthreading) cores and show + processor info. + commit ffeec05d913f2e987da362c05df2afc2a8a23965 Author: Johannes Ranke Date: 2018-01-29 10:11:27 +0100 diff --git a/DESCRIPTION b/DESCRIPTION index deb08cc..fb977ce 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: pfm Type: Package Title: Utilities for Pesticide Fate Modelling Version: 0.4-5 -Date: 2018-02-27 +Date: 2018-03-01 Authors@R: person("Johannes Ranke", email = "jranke@uni-bremen.de", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0003-4371-6538")) diff --git a/GNUmakefile b/GNUmakefile index 7951422..a6b575c 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -8,14 +8,15 @@ DATE := $(shell date +%Y-%m-%d) .PHONEY: usage check clean pkgfiles = DESCRIPTION \ - .Rbuildignore \ - data/* \ - docs/* \ - docs/reference/* \ - inst/testdata/* \ - R/* \ - tests/testthat.R \ - tests/testthat/* + .Rbuildignore \ + data/* \ + docs/* \ + docs/reference/* \ + inst/testdata/* \ + README.html \ + R/* \ + tests/testthat.R \ + tests/testthat/* clean: @echo "Cleaning up..." @@ -27,6 +28,9 @@ roxygen: "$(R_HOME)/bin/Rscript" -e 'devtools::document()' @echo "DONE." +README.html: README.md + "$(R_HOME)/bin/Rscript" -e "rmarkdown::render('README.md', output_format = 'html_document', output_options = list(mathjax = NULL))" + pd: roxygen @echo "Building static documentation..." # suppressWarnings to get rid of mbcsToSbcs warnings when plotting the 'µ' character diff --git a/README.html b/README.html new file mode 100644 index 0000000..026f011 --- /dev/null +++ b/README.html @@ -0,0 +1,176 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +
+

pfm

+

The R package pfm provides some utilities for fate modelling, including dealing with FOCUS pesticide fate modelling tools, (currently only TOXSWA cwa and out files), made available under the GNU public license. This means:

+
This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <http://www.gnu.org/licenses/>
+
+

Installation

+

You can install the package from github, e.g. using the devtools package. Using quick = TRUE skips docs, multiple-architecture builds, demos, and vignettes, to make installation as fast and painless as possible.

+
library(devtools)
+install_github("jranke/pfm", quick = TRUE)
+
+
+

Use

+

Please refer to the reference.

+
+
+

Examples

+

One recent nice example of the usage of this package is the visualisation of a time weighted average for a sawtooth curve obtained from several overlays of mkinfit predictions as shown here.

+

Another, even more recent example shows how FOCUS PELMO can be run in parallel under Linux as shown here.

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