Skip to content

Commit fbcf719

Browse files
authored
Merge pull request #251 from scverse/update_docs
Updated data usage docs
2 parents cb80ac2 + ada0703 commit fbcf719

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

src/decoupler/_docs.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,18 @@
4141

4242
_data = """\
4343
data
44-
AnnData instance, DataFrame or tuple of [matrix, samples, features]."""
44+
``anndata.AnnData`` instance, ``pandas.DataFrame``, or a tuple of ``(matrix, samples, features)``.
45+
All methods assume that input values follow a normal distribution unless
46+
otherwise specified. Therefore, when working with observational count data, some form of
47+
normalization is required (e.g., ``scanpy``'s library-size normalization followed
48+
by log1p). Using raw integer counts is not recommended, as they follow a Poisson distribution.
49+
50+
Feature scaling on normalized counts is also acceptable, but note that it changes
51+
the results by assuming equal importance across features, and outcomes will vary
52+
depending on which observations are included.
53+
54+
No normalization or transformation is required when using contrast-level
55+
feature statistics such as log fold changes or Wald test statistics."""
4556

4657
_layer = """\
4758
layer

src/decoupler/mt/_gsva.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ def _func_gsva(
349349
%(params)s
350350
kcdf
351351
Which kernel to use during the non-parametric estimation of the cumulative distribution function.
352-
Options are gaussian, poisson or None.
352+
Options are gaussian, poisson or None. The default is gaussian.
353353
mx_diff
354354
Changes how the enrichment statistic (ES) is calculated.
355355
If ``True`` (default), ES is calculated as the difference between the maximum positive and

0 commit comments

Comments
 (0)