From 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 25 Oct 2019 00:37:42 +0200 Subject: Use roxygen for functions and methods --- man/mkinparplot.Rd | 67 +++++++++++++++++++++++++++--------------------------- 1 file changed, 33 insertions(+), 34 deletions(-) (limited to 'man/mkinparplot.Rd') diff --git a/man/mkinparplot.Rd b/man/mkinparplot.Rd index a880151d..975a0203 100644 --- a/man/mkinparplot.Rd +++ b/man/mkinparplot.Rd @@ -1,34 +1,33 @@ -\name{mkinparplot} -\alias{mkinparplot} -\title{ - Function to plot the confidence intervals obtained using mkinfit -} -\description{ - This function plots the confidence intervals for the parameters - fitted using \code{\link{mkinfit}}. -} -\usage{ - mkinparplot(object) -} -\arguments{ - \item{object}{ - A fit represented in an \code{\link{mkinfit}} object. - } -} -\value{ - Nothing is returned by this function, as it is called for its side effect, namely to produce a plot. -} -\author{ - Johannes Ranke -} - -\examples{ -\dontrun{ -model <- mkinmod( - T245 = mkinsub("SFO", to = c("phenol"), sink = FALSE), - phenol = mkinsub("SFO", to = c("anisole")), - anisole = mkinsub("SFO"), use_of_ff = "max") -fit <- mkinfit(model, subset(mccall81_245T, soil == "Commerce"), quiet = TRUE) -mkinparplot(fit) -}} -\keyword{ hplot } +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/mkinparplot.R +\name{mkinparplot} +\alias{mkinparplot} +\title{Function to plot the confidence intervals obtained using mkinfit} +\usage{ +mkinparplot(object) +} +\arguments{ +\item{object}{A fit represented in an \code{\link{mkinfit}} object.} +} +\value{ +Nothing is returned by this function, as it is called for its side + effect, namely to produce a plot. +} +\description{ +This function plots the confidence intervals for the parameters fitted using +\code{\link{mkinfit}}. +} +\examples{ + +\dontrun{ +model <- mkinmod( + T245 = mkinsub("SFO", to = c("phenol"), sink = FALSE), + phenol = mkinsub("SFO", to = c("anisole")), + anisole = mkinsub("SFO"), use_of_ff = "max") +fit <- mkinfit(model, subset(mccall81_245T, soil == "Commerce"), quiet = TRUE) +mkinparplot(fit) +} +} +\author{ +Johannes Ranke +} -- cgit v1.2.1