Skip to content

Commit

Permalink
Updated paths after repo move to org
Browse files Browse the repository at this point in the history
  • Loading branch information
@andreped
andreped authored Jan 28, 2024
1 parent 589e33a commit 612d547
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -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)
<a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/breast_cancer_incidence_rate.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
![CI](https://github.com/andreped/breast-cancer-stats/workflows/incidence/badge.svg)
<a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/breast_cancer_incidence_rate.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
![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.
Expand All @@ -12,27 +12,27 @@ breast cancer data from the World Health Organization (WHO) database.
<img src="assets/incidence.png" width="90%" style="background-color:black">
</p>

## [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 | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/breast_cancer_incidence_rate.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/incidence.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/incidence/badge.svg" alt="Open In Colab"/></a> |
| Mortality rate world map | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/breast_cancer_mortality_rate.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/mortality.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/mortality/badge.svg" alt="Open In Colab"/></a> |
| Overall cancer statistics | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/breast_cancer_statistics.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/statistics.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/statistics/badge.svg" alt="Open In Colab"/></a> |
| Survival country comparison | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/bc_survival.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/survival.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/survival/badge.svg" alt="Open In Colab"/></a> |
| Cancer incidence over time | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/bc_incidence_over_time.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/incidence_temporal.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/incidence_temporal/badge.svg" alt="Open In Colab"/></a> |
| Cancer mortality over time | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/bc_mortality_over_time.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/mortality_temporal.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/mortality_temporal/badge.svg" alt="Open In Colab"/></a> |
| Cancer incidence over time w.r.t. age | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/bc_incidence_over_time_age_groups.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/incidence_temporal_age.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/incidence_temporal_age/badge.svg" alt="Open In Colab"/></a> |
| Cancer mortality over time w.r.t. age | <a href="https://colab.research.google.com/github/andreped/breast-cancer-stats/blob/main/apps/bc_mortality_over_time_age_groups.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/andreped/breast-cancer-stats/actions/workflows/mortality_temporal_age.yml" target="_parent"><img src="https://github.com/andreped/breast-cancer-stats/workflows/mortality_temporal_age/badge.svg" alt="Open In Colab"/></a> |
| Incidence rate world map | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/breast_cancer_incidence_rate.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/incidence.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/incidence/badge.svg" alt="Open In Colab"/></a> |
| Mortality rate world map | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/breast_cancer_mortality_rate.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/mortality.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/mortality/badge.svg" alt="Open In Colab"/></a> |
| Overall cancer statistics | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/breast_cancer_statistics.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/statistics.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/statistics/badge.svg" alt="Open In Colab"/></a> |
| Survival country comparison | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/bc_survival.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/survival.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/survival/badge.svg" alt="Open In Colab"/></a> |
| Cancer incidence over time | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/bc_incidence_over_time.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/incidence_temporal.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/incidence_temporal/badge.svg" alt="Open In Colab"/></a> |
| Cancer mortality over time | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/bc_mortality_over_time.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/mortality_temporal.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/mortality_temporal/badge.svg" alt="Open In Colab"/></a> |
| Cancer incidence over time w.r.t. age | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/bc_incidence_over_time_age_groups.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/incidence_temporal_age.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/incidence_temporal_age/badge.svg" alt="Open In Colab"/></a> |
| Cancer mortality over time w.r.t. age | <a href="https://colab.research.google.com/github/AICAN-Research/breast-cancer-stats/blob/main/apps/bc_mortality_over_time_age_groups.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | <a href="https://github.com/AICAN-Research/breast-cancer-stats/actions/workflows/mortality_temporal_age.yml" target="_parent"><img src="https://github.com/AICAN-Research/breast-cancer-stats/workflows/mortality_temporal_age/badge.svg" alt="Open In Colab"/></a> |

## [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:
Expand All @@ -42,23 +42,23 @@ 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).
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:

Expand Down

0 comments on commit 612d547

Please sign in to comment.