updated documentation for q

mbannick · Nov 17, 2021 · 3268853 · 3268853
1 parent 3a7b12b
commit 3268853
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 7 deletions.
diff --git a/R/estimators.R b/R/estimators.R
@@ -60,6 +60,7 @@ var.log.to.var <- function(estimate, variance) (estimate ** 2) * variance
 #' @param n Total number of observations (\eqn{n_n + n_p = n})
 #' @param mu Mean window period (in years, not days)
 #' @param mu_var Variance of the estimator for mean window period.
+#' @param q Fraction of positives that were given recency test, defaults to 1
 #'   If \eqn{\mu} is known, input 0.
 #' @return Returns a list of the estimate and the variance for \eqn{\lambda}.
 #' @examples

diff --git a/R/external-study-sim.R b/R/external-study-sim.R
@@ -259,7 +259,7 @@ assay.properties.est <- function(study, bigT, tau, last_point=TRUE){
 #'
 #' The external study data for mean window and MDRI is available here from
 #' Duong et al. 2015:
-#' # https://doi.org/10.1371/journal.pone.0114947.s001
+#' https://doi.org/10.1371/journal.pone.0114947.s001
 #'
 #' @export
 #' @param n_sims Number of simulations

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.10.1
 pkgdown: 1.6.1
 pkgdown_sha: ~
 articles: {}
-last_built: 2021-11-17T00:12Z
+last_built: 2021-11-17T00:19Z
 
diff --git a/docs/reference/assay.properties.nsim.html b/docs/reference/assay.properties.nsim.html
diff --git a/docs/reference/get.snapshot.html b/docs/reference/get.snapshot.html
diff --git a/man/assay.properties.nsim.Rd b/man/assay.properties.nsim.Rd
diff --git a/man/get.snapshot.Rd b/man/get.snapshot.Rd