Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added citation and link to vignette for splatPop #129

Merged
merged 1 commit into from
Jan 10, 2022
Merged

Added citation and link to vignette for splatPop #129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ aren't required for core functionality).
## Getting started

Once installed the best place to get started is the vignette. For most users
the most convenient way to access this is online [here][vignette].
the most convenient way to access this is online [here][vignette]. To get
started with population scale simulations, see the splatPop vignette
[here][splatpopvignette].

Alternatively, if you chose to build the vignette, you can load Splatter, then
browse the vignettes:
Expand Down Expand Up @@ -76,9 +78,26 @@ doi:10.1186/s13059-017-1305-0"][paper].
}
```

If you use the splatPop functions, please also cite ["Azodi CB, Zappia L, Oshlack
A, McCarthy DJ. splatPop: simulating population scale single-cell RNA sequencing
data. Genome Biology. 2021; doi:10.1186/s13059-021-02546-1"][splatpoppaper].

```
@Article{,
author = {Christina B Azodi and Luke Zappia and Alicia Oshlack and Davis J McCarthy},
title = {splatPop: simulating population scale single-cell RNA sequencing data},
journal = {Genome Biology},
year = {2021},
url = {http://dx.doi.org/10.1186/s13059-021-02546-1},
doi = {10.1186/s13059-021-02546-1},
}
```

[scater]: https://github.com/davismcc/scater
[SCE]: https://github.com/drisso/SingleCellExperiment
[contrib]: https://github.com/Bioconductor/Contributions/issues/209
[bioc]: https://bioconductor.org/packages/devel/bioc/html/splatter.html
[vignette]: https://bioconductor.org/packages/devel/bioc/vignettes/splatter/inst/doc/splatter.html
[splatpopvignette]: http://www.bioconductor.org/packages/devel/bioc/vignettes/splatter/inst/doc/splatPop.html
[paper]: http://dx.doi.org/10.1186/s13059-017-1305-0
[splatpoppaper]: http://dx.doi.org/10.1186/s13059-021-02546-1