Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Hie committed Jun 29, 2019
1 parent c54a71d commit 83ca32a
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions scanorama/scanorama.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,13 @@ def correct_scanpy(adatas, **kwargs):
Returns
-------
corrected
By default (`return_dimred=False`), returns a list of
`scanpy.api.AnnData` with batch corrected values in
`adata.obsm['X_scanorama']`.
By default (`return_dimred=False`), returns a list of new
`scanpy.api.AnnData`.
integrated, corrected
When `return_dimred=True`, returns a two-tuple containing a list of
`np.ndarray` with integrated low-dimensional embeddings and a list
of `scanpy.api.AnnData` with batch corrected values in
`adata.obsm['X_scanorama']`.
of new `scanpy.api.AnnData`.
"""
if 'return_dimred' in kwargs and kwargs['return_dimred']:
datasets_dimred, datasets, genes = correct(
Expand Down

0 comments on commit 83ca32a

Please sign in to comment.