Skip to content

Commit

Permalink
Add note about compilation time to qc metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
ivirshup committed Sep 25, 2019
1 parent 3a6c9db commit b9dbe36
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions scanpy/preprocessing/_qc.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ def describe_obs(
Calculates a number of qc metrics for observations in AnnData object. See
section `Returns` for a description of those metrics.
Note that this method can take a while to compile on the first call. That
result is then cached to disk to be used later.
Params
------
{doc_adata_basic}
Expand Down Expand Up @@ -223,6 +226,9 @@ def calculate_qc_metrics(
`Returns` for specifics. Largely based on `calculateQCMetrics` from scater
[McCarthy17]_. Currently is most efficient on a sparse CSR or dense matrix.
Note that this method can take a while to compile on the first call. That
result is then cached to disk to be used later.
Parameters
----------
{doc_adata_basic}
Expand Down

0 comments on commit b9dbe36

Please sign in to comment.