From 0bc79f02e99d719be5dbb96ed1591d46c8373c9f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 7 Feb 2020 08:13:14 +0100 Subject: Polish the static docs --- README.md | 21 +++++++++--- _pkgdown.yml | 22 +++++++++++++ docs/index.html | 13 ++++---- docs/reference/index.html | 83 +++++++++++++++++++++++++++++------------------ man/drfit-package.Rd | 34 ------------------- 5 files changed, 96 insertions(+), 77 deletions(-) create mode 100644 _pkgdown.yml delete mode 100644 man/drfit-package.Rd diff --git a/README.md b/README.md index 2430f79..fc01182 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ ---- -title: Readme file for the drfit R package ---- +# drfit [![](https://www.r-pkg.org/badges/version/drfit)](https://cran.r-project.org/package=drfit) -Static documentation of this R package can be found at -https://pkgdown.jrwb.de/drfit +A somewhat outdated package of basic and easy-to-use functions for +fitting dose-response curves to continuous dose-response data, calculating some +toxicological parameters and plotting the results. Please consider using +the more powerful and actively developed 'drc' package. + +Functions that are fitted are the cumulative density function of the log-normal +distribution ('probit' fit), of the logistic distribution ('logit' fit), of the +Weibull distribution ('weibull' fit) and a linear-logistic model ('linlogit' +fit), derived from the latter, which is used to describe data showing +stimulation at low doses (hormesis). In addition, functions checking, plotting +and retrieving dose-response data retrieved from a database accessed via 'odbc' +are included. As an alternative to the original fitting methods, the algorithms +from the 'drc' package can be used. + +More details can be found in the [function referenc](reference/index.html). diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..804e836 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,22 @@ +reference: + - title: Main functions + contents: + - drfit + - drcfit + - drplot + - title: Get and check data from a drfit database + desc: These functions only work if you have such a database + contents: + - checkcontrols + - checkplate + - drdata + - title: Datasets and example evaluations + contents: + - antifoul + - IM1xIPC81 + - IM1xVibrio + - pyrithione + - XY + - title: Helper functions + contents: + - linlogitf diff --git a/docs/index.html b/docs/index.html index 8b78e93..1b85668 100644 --- a/docs/index.html +++ b/docs/index.html @@ -70,15 +70,14 @@
+
+

+drfit

-
-
-

-title: Readme file for the drfit R package

- -

Static documentation of this R package can be found at https://pkgdown.jrwb.de/drfit

+

A somewhat outdated package of basic and easy-to-use functions for fitting dose-response curves to continuous dose-response data, calculating some toxicological parameters and plotting the results. Please consider using the more powerful and actively developed ‘drc’ package.

+

Functions that are fitted are the cumulative density function of the log-normal distribution (‘probit’ fit), of the logistic distribution (‘logit’ fit), of the Weibull distribution (‘weibull’ fit) and a linear-logistic model (‘linlogit’ fit), derived from the latter, which is used to describe data showing stimulation at low doses (hormesis). In addition, functions checking, plotting and retrieving dose-response data retrieved from a database accessed via ‘odbc’ are included. As an alternative to the original fitting methods, the algorithms from the ‘drc’ package can be used.

+

More details can be found in the function referenc.

-
diff --git a/man/drfit-package.Rd b/man/drfit-package.Rd deleted file mode 100644 index 06a147f..0000000 --- a/man/drfit-package.Rd +++ /dev/null @@ -1,34 +0,0 @@ -\name{drfit-package} -\alias{drfit-package} -\docType{package} -\title{ -Dose-response data evaluation -} -\description{ -See \url{../DESCRIPTION} -} -\details{ -There is an introductory article located in \url{../doc/drfit-Rnews.pdf}, -which will be published in the R News special edition on the use -of R for chemists. -} -\author{ -Author and Maintainer: Johannes Ranke -} -\note{There is a demo for each dataset that can be accessed by - \code{demo(dataset)}} -\keyword{ package } -\keyword{ models } -\keyword{ regression } -\keyword{ nonlinear } -\seealso{ -On CRAN, there is another, more statistically sophisticated package with -similar functionality called \code{drc}. I think the advantage of my package -is its user-friendliness. -} -\examples{ -data(antifoul) -r <- drfit(antifoul) -format(r,digits=2) -drplot(r,antifoul,overlay=TRUE,bw=FALSE) -} -- cgit v1.2.1