Merge pull request #39 from bedapub/osat_ref

add osat references
bedapub · Mar 11, 2024 · 7155129 · 7155129
2 parents fba78c1 + 2cdaf78
commit 7155129
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/R/osat.R b/R/osat.R
@@ -1,5 +1,9 @@
 #' Compute OSAT score for sample assignment.
 #'
+#' The OSAT score is intended to ensure even distribution of samples across
+#' batches and is closely related to the chi-square test contingency table
+#' (Yan et al. (2012) \doi{10.1186/1471-2164-13-689}).
+#'
 #' @param bc [BatchContainer] with samples
 #' or [`data.table`][data.table::data.table]/[data.frame] where every row is a location
 #' in a container and a sample in this location.

diff --git a/man/designit-package.Rd b/man/designit-package.Rd
diff --git a/man/osat_score.Rd b/man/osat_score.Rd
diff --git a/vignettes/osat.Rmd b/vignettes/osat.Rmd
@@ -18,6 +18,9 @@ knitr::opts_chunk$set(
 )
 ```
 
+In this vignette, we demonstrate how to use the OSAT score
+([Yan et al. (2012)](https://doi.org/10.1186/1471-2164-13-689)).
+
 ```{r setup}
 library(designit)
 library(tidyverse)