From 63262b03e9d594d727cb2d96060329252cb5b7eb Mon Sep 17 00:00:00 2001
From: Chris Orwa <chrisorwa@gmail.com>
Date: Wed, 11 Sep 2024 10:58:09 +0300
Subject: [PATCH] add documentation

---
 man/est.incidence.by.Rd  |  2 +-
 man/load_noise_params.Rd | 11 ++++++++---
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/man/est.incidence.by.Rd b/man/est.incidence.by.Rd
index 208fb0a2..fc6d7135 100644
--- a/man/est.incidence.by.Rd
+++ b/man/est.incidence.by.Rd
@@ -139,7 +139,7 @@ est2 <- est.incidence.by(
   curve_params = curve,
   noise_params = noise \%>\% filter(Country == "Pakistan"),
   antigen_isos = c("HlyE_IgG", "HlyE_IgA"),
-  #num_cores = 8 # Allow for parallel processing to decrease run time
+  # num_cores = 8 # Allow for parallel processing to decrease run time
   iterlim = 5 # limit iterations for the purpose of this example
 )
 
diff --git a/man/load_noise_params.Rd b/man/load_noise_params.Rd
index 34fb63fd..5d80402d 100644
--- a/man/load_noise_params.Rd
+++ b/man/load_noise_params.Rd
@@ -7,12 +7,17 @@
 load_noise_params(file_path, antigen_isos = NULL)
 }
 \arguments{
-\item{file_path}{path to an RDS file containing biologic and measurement noise of antibody decay curve parameters \code{y.low}, \code{eps}, \code{nu}, and \code{y.high}, stored as a \code{\link[=data.frame]{data.frame()}} or \link[tibble:tbl_df-class]{tibble::tbl_df}}
+\item{file_path}{path to an RDS file containing biologic
+and measurement noise of antibody decay curve parameters
+\code{y.low}, \code{eps}, \code{nu}, and \code{y.high},
+stored as a \code{\link[=data.frame]{data.frame()}} or \link[tibble:tbl_df-class]{tibble::tbl_df}}
 
-\item{antigen_isos}{\code{\link[=character]{character()}} vector of antigen isotypes to be used in analyses}
+\item{antigen_isos}{\code{\link[=character]{character()}} vector
+of antigen isotypes to be used in analyses}
 }
 \value{
-a \code{noise} object (a \link[tibble:tbl_df-class]{tibble::tbl_df} with extra attribute \code{antigen_isos})
+a \code{noise} object (a \link[tibble:tbl_df-class]{tibble::tbl_df}
+with extra attribute \code{antigen_isos})
 }
 \description{
 Load noise parameters