diff --git a/README.md b/README.md index 2f30a54..8e4c661 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# [breast-cancer-stats](https://github.com/andreped/breast-cancer-stats#breast-cancer-stats) +# [breast-cancer-stats](https://github.com/AICAN-Research/breast-cancer-stats#breast-cancer-stats) [![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/DAVFoundation/captain-n3m0/blob/master/LICENSE) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8232699.svg)](https://doi.org/10.5281/zenodo.8232699) - -![CI](https://github.com/andreped/breast-cancer-stats/workflows/incidence/badge.svg) + +![CI](https://github.com/AICAN-Research/breast-cancer-stats/workflows/incidence/badge.svg) This repository contains useful notebook examples on how to extract and visualize breast cancer data from the World Health Organization (WHO) database. @@ -12,27 +12,27 @@ breast cancer data from the World Health Organization (WHO) database.
-## [Examples](https://github.com/andreped/breast-cancer-stats#examples) +## [Examples](https://github.com/AICAN-Research/breast-cancer-stats#examples) -Example notebooks are available in the [apps/](https://github.com/andreped/breast-cancer-stats/tree/main/apps) directory. +Example notebooks are available in the [apps/](https://github.com/AICAN-Research/breast-cancer-stats/tree/main/apps) directory. They can also be accessed by clicking their respective CoLab badge below: | Use case | Notebook | Tests | | - | - | - | -| Incidence rate world map | | | -| Mortality rate world map | | | -| Overall cancer statistics | | | -| Survival country comparison | | | -| Cancer incidence over time | | | -| Cancer mortality over time | | | -| Cancer incidence over time w.r.t. age | | | -| Cancer mortality over time w.r.t. age | | | +| Incidence rate world map | | | +| Mortality rate world map | | | +| Overall cancer statistics | | | +| Survival country comparison | | | +| Cancer incidence over time | | | +| Cancer mortality over time | | | +| Cancer incidence over time w.r.t. age | | | +| Cancer mortality over time w.r.t. age | | | -## [Dependencies](https://github.com/andreped/breast-cancer-stats#dependencies) +## [Dependencies](https://github.com/AICAN-Research/breast-cancer-stats#dependencies) The Notebooks were tested against Python 3.8 on macOS operating system. Continuous integration tests are also performed for all notebooks -on Ubuntu 20.04 operating system (see [here](https://github.com/andreped/breast-cancer-stats/actions)). They are also compatible with +on Ubuntu 20.04 operating system (see [here](https://github.com/AICAN-Research/breast-cancer-stats/actions)). They are also compatible with Google CoLab and should be quite robust against other setups. The following dependencies were used and are installed as part of the notebooks: @@ -42,15 +42,15 @@ The following dependencies were used and are installed as part of the notebooks: * [nbformat](https://pypi.org/project/nbformat/) * [kaleido](https://pypi.org/project/kaleido/) -## [Troubleshooting](https://github.com/andreped/breast-cancer-stats#troubleshooting) +## [Troubleshooting](https://github.com/AICAN-Research/breast-cancer-stats#troubleshooting) Note that all rendered results could be interactive, but we have set Plotly's `show(renderer="png")`, to enable the result to be shown in the output on CoLab, on GitHub, and locally. To get interactive figures on CoLab set `show(renderer="colab")`, or locally use the default `show()`. GitHub only support static figures. -## [License](https://github.com/andreped/breast-cancer-stats#license) +## [License](https://github.com/AICAN-Research/breast-cancer-stats#license) -The code in this repository is released under [MIT license](https://github.com/andreped/breast-cancer-stats/blob/main/LICENSE). +The code in this repository is released under [MIT license](https://github.com/AICAN-Research/breast-cancer-stats/blob/main/LICENSE). Note that the CSV files originate from WHO-related websites. Global data from [Cancer Today](https://gco.iarc.fr/today/home) (powered by GLOBOCAN 2020) and Nordic data from [NORDCAN](https://nordcan.iarc.fr/en). @@ -58,7 +58,7 @@ If you use these figures or datasets, please, cite the appropriate references. Information on how to cite these can be found [here](https://gco.iarc.fr/today/about#references) and [here](https://nordcan.iarc.fr/en/about), respectively. -## [Citation](https://github.com/andreped/breast-cancer-stats#citation) +## [Citation](https://github.com/AICAN-Research/breast-cancer-stats#citation) If you found this project useful, please, consider citing it in your research article: