Skip to content

Commit 28b36ad

Browse files
committed
Update documentation and references.
Our Cytomulate paper is recently published on Genome Biology. Hooray!
1 parent 523cd0c commit 28b36ad

File tree

3 files changed

+31
-23
lines changed

3 files changed

+31
-23
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -180,19 +180,23 @@ Update is strongly recommended.
180180

181181
## References
182182

183-
If you used ``PyCytoData`` in your research or with ``Cytomulate`` as part of the pipeline, please cite [our paper](https://doi.org/10.1101/2022.06.14.496200) here:
183+
If you used ``PyCytoData`` in your research or with ``Cytomulate`` as part of the pipeline, please cite [our paper](https://doi.org/10.1186/s13059-023-03099-1) here:
184184

185185
```
186-
@article {Yang2022.06.14.496200,
186+
Yang, Y., Wang, K., Lu, Z. et al. Cytomulate: accurate and efficient simulation of CyTOF data. Genome Biol 24, 262 (2023). https://doi.org/10.1186/s13059-023-03099-1
187+
```
188+
189+
or with our BibTex:
190+
191+
```
192+
@article {Yang2023,
187193
author = {Yang, Yuqiu and Wang, Kaiwen and Lu, Zeyu and Wang, Tao and Wang, Xinlei},
188-
title = {Cytomulate: Accurate and Efficient Simulation of CyTOF data},
189-
elocation-id = {2022.06.14.496200},
190-
year = {2022},
191-
doi = {10.1101/2022.06.14.496200},
192-
publisher = {Cold Spring Harbor Laboratory},
193-
URL = {https://www.biorxiv.org/content/early/2022/06/16/2022.06.14.496200},
194-
eprint = {https://www.biorxiv.org/content/early/2022/06/16/2022.06.14.496200.full.pdf},
195-
journal = {bioRxiv}
194+
title = {Cytomulate: accurate and efficient simulation of CyTOF data},
195+
journal={Genome biology},
196+
volume={24},
197+
number={262},
198+
year={2023},
199+
publisher={Springer}
196200
}
197201
```
198202

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ tutorials below! Enjoy your journey working with CyTOF datasets!
6565
:hidden:
6666

6767
references
68-
Our Paper (Cytomulate) <https://doi.org/10.1101/2022.06.14.496200>
68+
Our Paper (Cytomulate) <https://doi.org/10.1186/s13059-023-03099-1>
6969
CyTOF DR Review (CytofDR) <https://doi.org/10.1038/s41467-023-37478-w>
7070
Dr. Xinlei (Shery) Wang <https://www.uta.edu/academics/faculty/profile?username=wangx9>
7171
Dr. Tao Wang <https://qbrc.swmed.edu/labs/wanglab/aboutpi.php>
@@ -80,7 +80,7 @@ Resources
8080

8181
For more resources on our labs, collaborators, and related projects, please visit the following:
8282

83-
* `Our Paper (Cytomulate) <https://doi.org/10.1101/2022.06.14.496200>`_
83+
* `Our Paper (Cytomulate) <https://doi.org/10.1186/s13059-023-03099-1>`_
8484
* `CyTOF DR Review Paper (CytofDR) <https://doi.org/10.1038/s41467-023-37478-w>`_
8585
* `Dr. Xinlei (Shery) Wang faculty page <https://www.uta.edu/academics/faculty/profile?username=wangx9>`_
8686
* `Dr. Tao Wang Lab <https://qbrc.swmed.edu/labs/wanglab/aboutpi.php>`_

docs/source/references.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,25 @@
22
References
33
################
44

5-
If you used ``PyCytoData`` as part of your research or used ``Cytomulate`` with this package, `our paper <https://doi.org/10.1101/2022.06.14.496200>`_
5+
If you used ``PyCytoData`` as part of your research or used ``Cytomulate`` with this package, `our paper <https://doi.org/10.1186/s13059-023-03099-1>`_
66
can be cited here:
77

8+
.. code-block::
9+
10+
Yang, Y., Wang, K., Lu, Z. et al. Cytomulate: accurate and efficient simulation of CyTOF data. Genome Biol 24, 262 (2023). https://doi.org/10.1186/s13059-023-03099-1
11+
12+
or
13+
814
.. code-block::
915
10-
@article {Yang2022.06.14.496200,
16+
@article {Yang2023,
1117
author = {Yang, Yuqiu and Wang, Kaiwen and Lu, Zeyu and Wang, Tao and Wang, Xinlei},
12-
title = {Cytomulate: Accurate and Efficient Simulation of CyTOF data},
13-
elocation-id = {2022.06.14.496200},
14-
year = {2022},
15-
doi = {10.1101/2022.06.14.496200},
16-
publisher = {Cold Spring Harbor Laboratory},
17-
URL = {https://www.biorxiv.org/content/early/2022/06/16/2022.06.14.496200},
18-
eprint = {https://www.biorxiv.org/content/early/2022/06/16/2022.06.14.496200.full.pdf},
19-
journal = {bioRxiv}
18+
title = {Cytomulate: accurate and efficient simulation of CyTOF data},
19+
journal={Genome biology},
20+
volume={24},
21+
number={262},
22+
year={2023},
23+
publisher={Springer}
2024
}
2125
2226
@@ -55,7 +59,7 @@ Benchmark Datasets
5559
********************
5660

5761
If you use the builtin datasets (``levine13``, ``levine32``, ``samusik``), you can cite the following papers
58-
along with ``HDCytoData``, which hosts these datasets.
62+
along with ``HDCytoData``, which serves as the inspiration for this package.
5963

6064
- Weber, L. M., & Soneson, C. (2019). HDCytoData: collection of high-dimensional cytometry benchmark datasets in Bioconductor object formats. F1000Research, 8.
6165
- Levine et al. (2015). Data-Driven Phenotypic Dissection of AML Reveals Progenitor-like Cells that Correlate with Prognosis. Cell, 162, pp. 184-197.

0 commit comments

Comments
 (0)