Skip to content

Commit

Permalink
document extra dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
kaizhang committed Aug 23, 2023
1 parent fdba242 commit 1d613a6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,16 @@ pip install .
Optional dependencies
---------------------

Here is a list of optional dependencies used by SnapATAC2:
`pip install snapatac2` installs the essential dependencies needed for SnapATAC2.
For certain features, however, additional optional dependencies are necessary:

- `macs2`: Peak calling.
- `harmonypy`: Batch correction using the Harmony.
- `xgboost`: Regulatory network analysis.
- harmonypy: For the `snapatac2.pp.harmony` function.
- scanorama: For the `snapatac2.pp.scanorama_integrate` function.
- xgboot: For network structure inference.

Optional dependencies are not installed by SnapATAC2. Please install them
manually if necessary.
To install these optional dependencies, use `pip install snapatac2[extra]`.

For downstream analysis, some helpful but not mandatory packages, such as scanpy and scvi-tools, are available.
They can be installed with `pip install snapatac2[recommend]`.

To obtain all optional dependencies at once, use `pip install snapatac2[all]`.
6 changes: 6 additions & 0 deletions snapatac2-python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"anndata>=0.8.0",
"kaleido",
"multiprocess",
"MACS2>=2.2.7",
"natsort",
"numpy>=1.16.0",
"pandas",
Expand All @@ -53,4 +54,9 @@
"typing_extensions",
"umap-learn>=0.5.0",
],
extras_require={
'extra': ['scanorama>=1.7.3', 'harmonypy>=0.0.9', 'xgboost>=1.4'],
'recommend': ['scanpy>=1.9', 'scvi-tools>=1.0'],
'all': ['snapatac2[extra]', 'snapatac2[recommend]']
}
)

0 comments on commit 1d613a6

Please sign in to comment.