Reorganise repository using standard package layout

1 files changed, 35 insertions, 0 deletions

diff --git a/man/pfm_degradation.Rd b/man/pfm_degradation.Rd
new file mode 100644
index 0000000..9ab1d0a
--- /dev/null
+++ b/man/pfm_degradation.Rd
@@ -0,0 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/pfm_degradation.R
+\name{pfm_degradation}
+\alias{pfm_degradation}
+\title{Calculate a time course of relative concentrations based on an mkinmod model}
+\usage{
+pfm_degradation(model = "SFO", DT50 = 1000, parms = c(k_parent_sink =
+  log(2)/DT50), years = 1, step_days = 1, times = seq(0, years * 365, by =
+  step_days))
+}
+\arguments{
+\item{model}{The degradation model to be used. Either a parent only model like
+'SFO' or 'FOMC', or an mkinmod object}
+
+\item{DT50}{The half-life. This is only used when simple exponential decline
+is calculated (SFO model).}
+
+\item{parms}{The parameters used for the degradation model}
+
+\item{years}{For how many years should the degradation be predicted?}
+
+\item{step_days}{What step size in days should the output have?}
+
+\item{times}{The output times}
+}
+\description{
+Calculate a time course of relative concentrations based on an mkinmod model
+}
+\examples{
+head(pfm_degradation("SFO", DT50 = 10))
+}
+\author{
+Johannes Ranke
+}
+