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/logLik.mkinfit.Rd | 54 +++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'man/logLik.mkinfit.Rd') diff --git a/man/logLik.mkinfit.Rd b/man/logLik.mkinfit.Rd index 5e910c2e..bb2c2957 100644 --- a/man/logLik.mkinfit.Rd +++ b/man/logLik.mkinfit.Rd @@ -1,39 +1,34 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/logLik.mkinfit.R \name{logLik.mkinfit} \alias{logLik.mkinfit} -\title{ - Calculated the log-likelihood of a fitted mkinfit object -} -\description{ - This function simply calculates the product of the likelihood densities - calculated using \code{\link{dnorm}}, i.e. assuming normal distribution, - with of the mean predicted by the degradation model, and the - standard deviation predicted by the error model. - - The total number of estimated parameters returned with the value - of the likelihood is calculated as the sum of fitted degradation - model parameters and the fitted error model parameters. -} +\title{Calculated the log-likelihood of a fitted mkinfit object} \usage{ - \method{logLik}{mkinfit}(object, ...) +\method{logLik}{mkinfit}(object, ...) } \arguments{ - \item{object}{ - An object of class \code{\link{mkinfit}}. - } - \item{\dots}{ - For compatibility with the generic method - } +\item{object}{An object of class \code{\link{mkinfit}}.} + +\item{\dots}{For compatibility with the generic method} } \value{ - An object of class \code{\link{logLik}} with the number of - estimated parameters (degradation model parameters plus variance - model parameters) as attribute. +An object of class \code{\link{logLik}} with the number of estimated + parameters (degradation model parameters plus variance model parameters) + as attribute. } -\seealso{ - Compare the AIC of columns of \code{\link{mmkin}} objects using - \code{\link{AIC.mmkin}}. +\description{ +This function simply calculates the product of the likelihood densities +calculated using \code{\link{dnorm}}, i.e. assuming normal distribution, +with of the mean predicted by the degradation model, and the standard +deviation predicted by the error model. +} +\details{ +The total number of estimated parameters returned with the value of the +likelihood is calculated as the sum of fitted degradation model parameters +and the fitted error model parameters. } \examples{ + \dontrun{ sfo_sfo <- mkinmod( parent = mkinsub("SFO", to = "m1"), @@ -45,7 +40,12 @@ f_tc <- mkinfit(sfo_sfo, d_t, error_model = "tc", quiet = TRUE) AIC(f_nw, f_obs, f_tc) } + +} +\seealso{ +Compare the AIC of columns of \code{\link{mmkin}} objects using + \code{\link{AIC.mmkin}}. } \author{ - Johannes Ranke +Johannes Ranke } -- cgit v1.2.1