Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
llrs committed Feb 19, 2024
1 parent f0b0651 commit 6047f76
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 16 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ Config/testthat/edition: 3
Encoding: UTF-8
Language: en-US
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.0
37 changes: 22 additions & 15 deletions R/experDesign-package.R
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
#' experDesign: Expert experiment design in batches
#'
#' Enables easy distribution of samples per batch avoiding batch and
#' confounding effects by randomization of the variables in each batch.
#'
#' The most important function is [design()], which distributes
#' samples in batches according to the information provided.
#'
#' To help in the bench there is the [inspect()] function that appends
#' the group to the data provided.
#' @author Lluís Revilla
#' @name experDesign-package
#' @aliases experDesign
#' @docType package
NULL
#' experDesign: Expert experiment design in batches
#'
#' Enables easy distribution of samples per batch avoiding batch and
#' confounding effects by randomization of the variables in each batch.
#'
#' The most important function is [design()], which distributes
#' samples in batches according to the information provided.
#'
#' To help in the bench there is the [inspect()] function that appends
#' the group to the data provided.
#'
#' If you have a grid or some spatial data, you might want to look at the
#' [spatial()] function to distribute the samples while keeping the original
#' design.
#'
#' In case an experiment was half processed and you need to extend it you can
#' use [follow_up()] or [follow_up2()]. It helps selecting which samples
#' already used should be used in the follow up.
#' @author Lluís Revilla
#' @name experDesign-package
#' @aliases experDesign
"_PACKAGE"
17 changes: 17 additions & 0 deletions man/experDesign-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6047f76

Please sign in to comment.