Skip to content

Commit 94a99ac

Browse files
committed
Add note on catagorical & syntactically valid catagories in var_registation documentation
1 parent c08ac1f commit 94a99ac

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

R/registration_pseudobulk.R

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
#' object or one that inherits its properties.
99
#' @param var_registration A `character(1)` specifying the `colData(sce)`
1010
#' variable of interest against which will be used for computing the relevant
11-
#' statistics.
11+
#' statistics. This should be a categorical variable, with all categories
12+
#' syntaticly valid (could be used as an R variable, no special characters or
13+
#' leading numbers), ex. 'L1.2', 'celltype2' not 'L1/2' or '2'.
1214
#' @param var_sample_id A `character(1)` specifying the `colData(sce)` variable
1315
#' with the sample ID.
1416
#' @param covars A `character()` with names of sample-level covariates.

man/registration_pseudobulk.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/registration_wrapper.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)