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/mkin_wide_to_long.Rd | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) (limited to 'man/mkin_wide_to_long.Rd') diff --git a/man/mkin_wide_to_long.Rd b/man/mkin_wide_to_long.Rd index dc523755..402911d7 100644 --- a/man/mkin_wide_to_long.Rd +++ b/man/mkin_wide_to_long.Rd @@ -1,32 +1,33 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/mkin_wide_to_long.R \name{mkin_wide_to_long} \alias{mkin_wide_to_long} -\title{ - Convert a dataframe with observations over time into long format -} +\title{Convert a dataframe with observations over time into long format} \usage{ mkin_wide_to_long(wide_data, time = "t") } -\description{ - This function simply takes a dataframe with one independent variable and several - dependent variable and converts it into the long form as required by \code{\link{mkinfit}}. -} \arguments{ - \item{wide_data}{ - The dataframe must contain one variable with the time values specified by the - \code{time} argument and usually more than one column of observed values. -} - \item{time}{ - The name of the time variable. -} +\item{wide_data}{The dataframe must contain one variable with the time +values specified by the \code{time} argument and usually more than one +column of observed values.} + +\item{time}{The name of the time variable.} } \value{ - Dataframe in long format as needed for \code{\link{mkinfit}}. +Dataframe in long format as needed for \code{\link{mkinfit}}. } -\author{ - Johannes Ranke +\description{ +This function simply takes a dataframe with one independent variable and +several dependent variable and converts it into the long form as required by +\code{\link{mkinfit}}. } \examples{ + wide <- data.frame(t = c(1,2,3), x = c(1,4,7), y = c(3,4,5)) mkin_wide_to_long(wide) + +} +\author{ +Johannes Ranke } -\keyword{ manip } +\keyword{manip} -- cgit v1.2.1