From 7777ff3b019e54364947ff393e2dab782d7cfe3c Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Fri, 10 Apr 2020 08:26:44 +0200
Subject: Improve nlme function docs

---
 man/nlme.Rd | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

(limited to 'man/nlme.Rd')

diff --git a/man/nlme.Rd b/man/nlme.Rd
index e74ba16d..7527f09d 100644
--- a/man/nlme.Rd
+++ b/man/nlme.Rd
@@ -1,29 +1,29 @@
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/nlme.R
-\name{mean_degparms}
+\name{nlme_function}
+\alias{nlme_function}
 \alias{mean_degparms}
 \alias{nlme_data}
-\alias{nlme_function}
 \title{Estimation of parameter distributions from mmkin row objects}
 \usage{
+nlme_function(object)
+
 mean_degparms(object)
 
 nlme_data(object)
-
-nlme_function(object)
 }
 \arguments{
 \item{object}{An mmkin row object containing several fits of the same model to different datasets}
 }
 \value{
-A named vector containing mean values of the fitted degradation model parameters
+A function that can be used with \code{link{nlme}}
 
-A groupedData data object
+A named vector containing mean values of the fitted degradation model parameters
 
-A function that can be used with nlme
+A \code{\link{groupedData}} object
 }
 \description{
-This function sets up and attempts to fit a mixed effects model to
+These functions facilitate setting up a nonlinear mixed effects model for
 an mmkin row object. An mmkin row object is essentially a list of mkinfit
 objects that have been obtained by fitting the same model to a list of
 datasets.
@@ -63,7 +63,7 @@ m_nlme <- nlme(value ~ nlme_f(name, time, parent_0, log_k_parent_sink),
 summary(m_nlme)
 
 \dontrun{
-  Test on some real data
+  # Test on some real data
   ds_2 <- lapply(experimental_data_for_UBA_2019[6:10],
    function(x) x$data[c("name", "time", "value")])
   m_sfo_sfo <- mkinmod(parent = mkinsub("SFO", "A1"),
-- 
cgit v1.2.1