Citation info (vitessce#1539)

* Citation file * Update citation * Docs, update affiliation * Space
Carton22 · May 26, 2023 · 5827ff9 · 5827ff9
1 parent 0c32ba3
commit 5827ff9
Show file tree

Hide file tree

Showing 4 changed files with 119 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 - Added developer troubleshooting instructions to README.
 - Add `useFullResolutionImage` to `Spatial` to allow for loading only full resolution image from pyramid.
 - Implemented ability to select an area on the Expression Histogram. On select, a new obs set selection is created. The new selection contains the ids of all obs that belong to the selected bars.
+- Add `CITATION.cff`
 
 ### Changed
 - Fix hot module reloading by refactoring JS files that export React components (the component needs to be the only export for HMR to work). Add react-refresh eslint plugin to check for this moving forward.

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,60 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using these metadata."
+title: "Vitessce"
+authors:
+  - given-names: "Mark S."
+    family-names: "Keller"
+    affiliation: "Harvard Medical School"
+    orcid: "https://orcid.org/0000-0003-3003-874X"
+  - given-names: "Ilan"
+    family-names: "Gold"
+    orcid: "https://orcid.org/0000-0002-5823-1026"
+    affiliation: "Harvard Medical School"
+  - given-names: "Trevor"
+    family-names: "Manz"
+    orcid: "https://orcid.org/0000-0001-7694-5164"
+    affiliation: "Harvard Medical School"
+  - given-names: "Iva"
+    family-names: "Babukova"
+    affiliation: "Biomage"
+  - given-names: "Chuck"
+    family-names: "McCallum"
+    orcid: "https://orcid.org/0000-0003-4039-9768"
+    affiliation: "Harvard Medical School"
+  - family-names: "Gehlenborg"
+    given-names: "Nils"
+    orcid: "https://orcid.org/0000-0003-0327-8297"
+    affiliation: "Harvard Medical School"
+url: "https://github.com/vitessce/vitessce"
+preferred-citation:
+  type: article
+  title: "Vitessce: a framework for integrative visualization of multi-modal and spatially-resolved single-cell data"
+  authors:
+    - given-names: "Mark S."
+      family-names: "Keller"
+      affiliation: "Harvard Medical School"
+      orcid: "https://orcid.org/0000-0003-3003-874X"
+    - given-names: "Ilan"
+      family-names: "Gold"
+      orcid: "https://orcid.org/0000-0002-5823-1026"
+      affiliation: "Harvard Medical School"
+    - given-names: "Chuck"
+      family-names: "McCallum"
+      affiliation: "Harvard Medical School"
+      orcid: "https://orcid.org/0000-0003-4039-9768"
+    - given-names: "Trevor"
+      family-names: "Manz"
+      orcid: "https://orcid.org/0000-0001-7694-5164"
+      affiliation: "Harvard Medical School"
+    - given-names: "Peter V."
+      family-names: "Kharchenko"
+      affiliation: "Harvard Medical School"
+      orcid: "https://orcid.org/0000-0002-6036-5875"
+    - given-names: "Nils"
+      family-names: "Gehlenborg"
+      affiliation: "Harvard Medical School"
+      orcid: "https://orcid.org/0000-0003-0327-8297"
+  journal: "OSF preprint"
+  doi: 10.31219/osf.io/y8thv
+  month: 10
+  year: 2021
diff --git a/README.md b/README.md
@@ -244,3 +244,31 @@ Changes to the directory structure or filenames in the `dist/` directory that co
 - [May 2019: Harvard IT Summit](https://docs.google.com/presentation/d/1eYDMedzhQtcClB2cIBo17hlaSSAu_-vzkG4LY_mGGQ8/edit#slide=id.p)
 - [May 2019: Misc. tools](https://docs.google.com/presentation/d/1TaC68-r6bosnwi05BZ5bNh9tzeXsxyqmBo1gFZDxhGM/edit#slide=id.p)
 - [April 2019: Software engineering](https://docs.google.com/presentation/d/1uW3J83LYaa67M9ZKe15AQw_h06QiFJBzpBickbRFcCY/edit#slide=id.p)
+
+## Citation
+
+To cite Vitessce in your work, please use:
+
+```bibtex
+@article{keller2021vitessce,
+  title = {{Vitessce: a framework for integrative visualization of multi-modal and spatially-resolved single-cell data}},
+  author = {Keller, Mark S. and Gold, Ilan and McCallum, Chuck and Manz, Trevor and Kharchenko, Peter V. and Gehlenborg, Nils},
+  journal = {OSF Preprints},
+  year = {2021},
+  month = oct,
+  doi = {10.31219/osf.io/y8thv}
+}
+```
+
+If you use the image rendering functionality, please additionally cite Viv:
+
+```bibtex
+@article{manz2022viv,
+  title = {{Viv: multiscale visualization of high-resolution multiplexed bioimaging data on the web}},
+  author = {Manz, Trevor and Gold, Ilan and Patterson, Nathan Heath and McCallum, Chuck and Keller, Mark S. and Herr, II, Bruce W. and Börner, Kay and Spraggins, Jeffrey M. and Gehlenborg, Nils},
+  journal = {Nature Methods},
+  year = {2022},
+  month = may,
+  doi = {10.1038/s41592-022-01482-7}
+}
+```
diff --git a/sites/docs/docs/about.md b/sites/docs/docs/about.md
@@ -4,8 +4,36 @@ title: About
 slug: /about
 ---
 
-Vitessce is developed by the [Gehlenborg Lab](http://gehlenborglab.org/research/projects/vitessce/) at Harvard Medical School.
+Vitessce is developed by the [HiDIVE Lab](http://gehlenborglab.org/research/projects/vitessce/) at Harvard Medical School.
 
 ## Contributors
 
-<ul><li><a href="https://github.com/keller-mark">Mark Keller</a></li><li><a href="https://github.com/mccalluc">Chuck McCallum</a></li><li><a href="https://github.com/ilan-gold">Ilan Gold</a></li><li><a href="https://github.com/manzt">Trevor Manz</a></li><li><a href="https://github.com/thomaslchan">Tos Chan</a></li><li><a href="https://github.com/sehilyi">Sehi Lyi</a></li><li><a href="https://github.com/jkmarx">Jennifer Marx</a></li><li><a href="https://github.com/pkharchenko">Peter Kharchenko</a></li><li><a href="https://github.com/ngehlenborg">Nils Gehlenborg</a></li></ul>
+View code contributors on [GitHub](https://github.com/vitessce/vitessce/graphs/contributors?type=a).
+
+## Citation
+
+To cite Vitessce in your work, please use:
+
+```bibtex
+@article{keller2021vitessce,
+  title = {{Vitessce: a framework for integrative visualization of multi-modal and spatially-resolved single-cell data}},
+  author = {Keller, Mark S. and Gold, Ilan and McCallum, Chuck and Manz, Trevor and Kharchenko, Peter V. and Gehlenborg, Nils},
+  journal = {OSF Preprints},
+  year = {2021},
+  month = oct,
+  doi = {10.31219/osf.io/y8thv}
+}
+```
+
+If you use the image rendering functionality, please additionally cite Viv:
+
+```bibtex
+@article{manz2022viv,
+  title = {{Viv: multiscale visualization of high-resolution multiplexed bioimaging data on the web}},
+  author = {Manz, Trevor and Gold, Ilan and Patterson, Nathan Heath and McCallum, Chuck and Keller, Mark S. and Herr, II, Bruce W. and Börner, Kay and Spraggins, Jeffrey M. and Gehlenborg, Nils},
+  journal = {Nature Methods},
+  year = {2022},
+  month = may,
+  doi = {10.1038/s41592-022-01482-7}
+}
+```