% 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 = 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}
}
\value{
A data frame containing the output times and the concentrations
assuming initial concentrations of 1 for the parent and zero for
metabolites, if any.
}
\description{
Calculate a time course of relative concentrations based on an mkinmod model
}
\examples{
# Simple example of an SFO decline curve
sfo_out <- pfm_degradation("SFO", DT50 = 10)
head(sfo_out)

# Fictive example with a metabolite where we first generate an SFO-SFO model
sfo_sfo <- mkinmod(
  parent = mkinsub("SFO", to = "metabolite"),
  metabolite = mkinsub("SFO"))

sfo_sfo_out <- pfm_degradation(sfo_sfo,
  parms = c(k_parent = 0.1, f_parent_to_metabolite = 0.5, k_metabolite = 0.02))

plot(
  sfo_sfo_out[, "time"],
  sfo_sfo_out[, "parent"], type = "l",
  xlab = "Time", ylab = "Relative concentration",
  xlim = c(0, 100))
lines(
  sfo_sfo_out[, "time"],
  sfo_sfo_out[, "metabolite"], lty = 2)

}
\author{
Johannes Ranke
}