Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jleechung committed Mar 8, 2024
1 parent c5ca77b commit 86b4056
Show file tree
Hide file tree
Showing 8 changed files with 95 additions and 49 deletions.
13 changes: 10 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,16 @@ BANKSY is applicable to a wide array of spatial technologies (e.g. 10x Visium,
Slide-seq, MERFISH, CosMX, CODEX) and scales well to large datasets. For more
details, check out:

- the [preprint](https://www.biorxiv.org/content/10.1101/2022.04.14.488259v1),
- a [tweetorial](https://twitter.com/vipul1891/status/1515323372535644166?s=20&t=Bc6rz8VeWWptF67FejGYfQ) on BANKSY,
- and a [Python version](https://github.com/prabhakarlab/Banksy_py) of this package.
- the [paper](https://www.nature.com/articles/s41588-024-01664-3),
- the [peer review file](https://static-content.springer.com/esm/art%3A10.1038%2Fs41588-024-01664-3/MediaObjects/41588_2024_1664_MOESM3_ESM.pdf),
- a [tweetorial](https://x.com/shyam_lab/status/1762648072360792479?s=20) on BANKSY,
- a set of [vignettes](https://prabhakarlab.github.io/Banksy) showing basic
usage,
- a [Python version](https://github.com/prabhakarlab/Banksy_py) of this package,
- a [Zenodo archive](https://zenodo.org/records/10258795) containing scripts to
reproduce the analyses in the paper, and the corresponding
[GitHub Pages](https://github.com/jleechung/banksy-zenodo)
(and [here](https://github.com/prabhakarlab/Banksy_py/tree/Banksy_manuscript) for analyses done in Python).

## Installation

Expand Down
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,21 @@ BANKSY is applicable to a wide array of spatial technologies (e.g. 10x
Visium, Slide-seq, MERFISH, CosMX, CODEX) and scales well to large
datasets. For more details, check out:

- the
[preprint](https://www.biorxiv.org/content/10.1101/2022.04.14.488259v1),
- the [paper](https://www.nature.com/articles/s41588-024-01664-3),
- the [peer review
file](https://static-content.springer.com/esm/art%3A10.1038%2Fs41588-024-01664-3/MediaObjects/41588_2024_1664_MOESM3_ESM.pdf),
- a
[tweetorial](https://twitter.com/vipul1891/status/1515323372535644166?s=20&t=Bc6rz8VeWWptF67FejGYfQ)
[tweetorial](https://x.com/shyam_lab/status/1762648072360792479?s=20)
on BANKSY,
- and a [Python version](https://github.com/prabhakarlab/Banksy_py) of
this package.
- a set of [vignettes](https://prabhakarlab.github.io/Banksy) showing
basic usage,
- a [Python version](https://github.com/prabhakarlab/Banksy_py) of this
package,
- a [Zenodo archive](https://zenodo.org/records/10258795) containing
scripts to reproduce the analyses in the paper, and the corresponding
[GitHub Pages](https://github.com/jleechung/banksy-zenodo) (and
[here](https://github.com/prabhakarlab/Banksy_py/tree/Banksy_manuscript)
for analyses done in Python).

## Installation

Expand Down Expand Up @@ -204,7 +212,7 @@ plot_grid(
Runtime for analysis
</summary>

#> Time difference of 1.159899 mins
#> Time difference of 1.312978 mins

</details>
<details>
Expand Down
4 changes: 2 additions & 2 deletions docs/articles/batch-correction.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/articles/multi-sample.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 23 additions & 3 deletions docs/articles/parameter-selection.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 86b4056

Please sign in to comment.