Add note on catagorical & syntactically valid catagories in var_regis…

…tation documentation
LieberInstitute · Dec 12, 2024 · 94a99ac · 94a99ac
1 parent c08ac1f
commit 94a99ac
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/R/registration_pseudobulk.R b/R/registration_pseudobulk.R
@@ -8,7 +8,9 @@
 #' object or one that inherits its properties.
 #' @param var_registration A `character(1)` specifying the `colData(sce)`
 #' variable of interest against which will be used for computing the relevant
-#' statistics.
+#' statistics. This should be a categorical variable, with all categories 
+#' syntaticly valid (could be used as an R variable, no special characters or 
+#' leading numbers), ex. 'L1.2', 'celltype2' not 'L1/2' or '2'.
 #' @param var_sample_id A `character(1)` specifying the `colData(sce)` variable
 #' with the sample ID.
 #' @param covars A `character()` with names of sample-level covariates.

diff --git a/man/registration_pseudobulk.Rd b/man/registration_pseudobulk.Rd
diff --git a/man/registration_wrapper.Rd b/man/registration_wrapper.Rd