export trim.sample

uclahs-cds · Sep 17, 2024 · e9185d6 · e9185d6
1 parent 1769f04
commit e9185d6
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -2,3 +2,4 @@
 
 export(detect.outliers)
 export(identify.bic.optimal.data.distribution)
+export(trim.sample)
diff --git a/R/trim.sample.R b/R/trim.sample.R
@@ -7,14 +7,12 @@
 #' @param x A numeric vector.
 #' @param trim A number, the fraction of observations to be trimmed from each end of `x`.
 #' @return A sorted, trimmed copy of `x`.
-#'
+#' @export trim.sample
 #' @examples
 #' trim.sample(
 #'     x = 1:20,
 #'     trim = 0.05
 #'     );
-#'
-#' @noRd
 trim.sample <- function(x, trim = 0.05) {
     x <- sort(x);
     if (length(x) <= 10) {

diff --git a/man/trim.sample.Rd b/man/trim.sample.Rd