Skip to content

Commit 06e8a4f

Browse files
shaneahmedJohn-P
andauthored
[skip ci] DOC: Update citation in README.md and CITATION.cff (#480)
- Update citation in README.md and CITATION.cff Co-authored-by: John Pocock <[email protected]>
1 parent fafa65e commit 06e8a4f

File tree

2 files changed

+56
-33
lines changed

2 files changed

+56
-33
lines changed

CITATION.cff

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ authors:
4343
- family-names: "Raza"
4444
given-names: "Shan E Ahmed"
4545
orcid: "https://orcid.org/0000-0002-1097-1738"
46-
title: "TIAToolbox: An End-to-End Toolbox for Advanced Tissue Image Analytics"
46+
title: "TIAToolbox as an end-to-end library for advanced tissue image analytics"
4747
version: 1.2.1
4848
doi: 10.5281/zenodo.5802442
4949
date-released: 2022-07-07
@@ -93,8 +93,8 @@ preferred-citation:
9393
- family-names: "Raza"
9494
given-names: "Shan E Ahmed"
9595
orcid: "https://orcid.org/0000-0002-1097-1738"
96-
doi: "10.1101/2021.12.23.474029"
97-
journal: "bioRxiv"
98-
month: 12
99-
title: "TIAToolbox: An End-to-End Toolbox for Advanced Tissue Image Analytics"
100-
year: 2021
96+
doi: "10.1038/s43856-022-00186-5"
97+
journal: "Communications Medicine"
98+
month: 09
99+
title: "TIAToolbox as an end-to-end library for advanced tissue image analytics"
100+
year: 2022

README.md

Lines changed: 50 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,69 @@
22
<img src="https://raw.githubusercontent.com/TissueImageAnalytics/tiatoolbox/develop/docs/tiatoolbox-logo.png">
33
</p>
44
<h1 align="center">TIA Toolbox</h1>
5-
<p align="center">
6-
<a href="https://tia-toolbox.readthedocs.io/en/latest/?badge=latest">
7-
<img src="https://readthedocs.org/projects/tia-toolbox/badge/?version=latest" alt="Documentation Status" />
8-
</a>
9-
<a href="https://travis-ci.com/github/TissueImageAnalytics/tiatoolbox">
10-
<img src="https://app.travis-ci.com/TissueImageAnalytics/tiatoolbox.svg?branch=master" alt="Travis CI Status" />
11-
</a>
12-
<a href="https://codecov.io/gh/TissueImageAnalytics/tiatoolbox">
13-
<img src="https://codecov.io/gh/TissueImageAnalytics/tiatoolbox/branch/master/graph/badge.svg?token=7UZEMacQHm"/>
14-
</a>
15-
<a href="https://github.com/psf/black">
16-
<img src="https://img.shields.io/badge/code%20style-black-000000.svg"/>
17-
</a>
18-
<a href="https://github.com/TissueImageAnalytics/tiatoolbox/tree/master#license">
19-
<img src="https://img.shields.io/badge/license-BSD--3--clause-orange" />
20-
</a>
21-
<br>
22-
<br>
235
<a href="https://badge.fury.io/py/tiatoolbox">
246
<img src="https://badge.fury.io/py/tiatoolbox.svg" alt="PyPI Status" />
257
</a>
268
<a href="https://pepy.tech/project/tiatoolbox">
27-
<img src="https://static.pepy.tech/personalized-badge/tiatoolbox?period=total&units=international_system&left_color=grey&right_color=green&left_text=Downloads"/>
9+
<img src="https://static.pepy.tech/personalized-badge/tiatoolbox?period=total&units=international_system&left_color=grey&right_color=green&left_text=downloads" alt="pypi Downloads"/>
2810
</a>
2911
<br>
3012
<a href="https://anaconda.org/conda-forge/tiatoolbox">
31-
<img src="https://img.shields.io/conda/vn/conda-forge/tiatoolbox" />
13+
<img src="https://img.shields.io/conda/vn/conda-forge/tiatoolbox" alt="conda-forge badge"/>
3214
</a>
3315
<a href="https://anaconda.org/conda-forge/tiatoolbox">
34-
<img src="https://anaconda.org/conda-forge/tiatoolbox/badges/downloads.svg" />
16+
<img src="https://shields.io/conda/dn/conda-forge/tiatoolbox" alt="conda-forge downloads"/>
3517
</a>
36-
37-
<br>
38-
<br>
39-
<a href="https://doi.org/10.1101/2021.12.23.474029"><img src="https://img.shields.io/badge/bioRxiv-10.1101%2F2021.12.23.474029-blue" alt="DOI"></a>
40-
<a href="https://zenodo.org/badge/latestdoi/267705904"><img src="https://zenodo.org/badge/267705904.svg" alt="DOI"></a>
41-
</p>
18+
<br>
19+
<a href="https://github.com/TissueImageAnalytics/tiatoolbox/tree/master#license">
20+
<img src="https://img.shields.io/badge/license-BSD--3--clause-orange" alt="License BSD-3-Clause"/>
21+
</a>
22+
<br>
23+
<br>
24+
<a href="https://github.com/TissueImageAnalytics/tiatoolbox/actions/workflows/pip-install.yml">
25+
<img src="https://img.shields.io/pypi/pyversions/tiatoolbox.svg" alt="Supported Python versions"/>
26+
</a>
27+
<a href="https://github.com/psf/black">
28+
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style black"/>
29+
</a>
30+
<a href="https://github.com/TissueImageAnalytics/tiatoolbox/actions/workflows/python-package.yml">
31+
<img src="https://github.com/TissueImageAnalytics/tiatoolbox/actions/workflows/python-package.yml/badge.svg" alt="GitHub Workflow passing"/>
32+
</a>
33+
<a href="https://tia-toolbox.readthedocs.io/en/latest/?badge=latest">
34+
<img src="https://readthedocs.org/projects/tia-toolbox/badge/?version=latest" alt="Documentation Status" />
35+
</a>
36+
<a href="https://codecov.io/gh/TissueImageAnalytics/tiatoolbox">
37+
<img src="https://codecov.io/gh/TissueImageAnalytics/tiatoolbox/branch/master/graph/badge.svg?token=7UZEMacQHm" alt="Code Coverage"/>
38+
</a>
39+
<br><br>
40+
<a href="https://doi.org/10.1038/s43856-022-00186-5"><img src="https://img.shields.io/badge/DOI-10.1038%2Fs43856--022--00186--5-blue" alt="DOI"></a>
4241

4342
Computational Pathology Toolbox developed at the TIA Centre
4443

44+
## Cite this repository
45+
46+
If you find TIAToolbox useful or use it in your research, please consider citing our paper:
47+
48+
Pocock, J. et al. TIAToolbox as an end-to-end library for advanced tissue image analytics. Communications Medicine 2, 120 (2022).
49+
50+
```
51+
@article{
52+
Pocock2022,
53+
author = {Pocock, Johnathan and Graham, Simon and Vu, Quoc Dang and Jahanifar, Mostafa and Deshpande, Srijay and Hadjigeorghiou, Giorgos and Shephard, Adam and Bashir, Raja Muhammad Saad and Bilal, Mohsin and Lu, Wenqi and Epstein, David and Minhas, Fayyaz and Rajpoot, Nasir M and Raza, Shan E Ahmed},
54+
doi = {10.1038/s43856-022-00186-5},
55+
issn = {2730-664X},
56+
journal = {Communications Medicine},
57+
month = {sep},
58+
number = {1},
59+
pages = {120},
60+
publisher = {Springer US},
61+
title = {{TIAToolbox as an end-to-end library for advanced tissue image analytics}},
62+
url = {https://www.nature.com/articles/s43856-022-00186-5},
63+
volume = {2},
64+
year = {2022}
65+
}
66+
```
67+
4568
## Getting Started
4669

4770
### All Users

0 commit comments

Comments
 (0)