Skip to content

Commit

Permalink
Renamed notebooks + refactored README
Browse files Browse the repository at this point in the history
  • Loading branch information
andreped committed Aug 8, 2023
1 parent f9a3c78 commit 871c897
Show file tree
Hide file tree
Showing 3 changed files with 243 additions and 249 deletions.
50 changes: 14 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,28 @@
[![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/DAVFoundation/captain-n3m0/blob/master/LICENSE)
<a href="https://colab.research.google.com/gist/andreped/4b0988424c837c8060835ed15b8ee1e9/breast_cancer_mortality_rate_world_map.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>

This repository holds source code and examples on how to extract and visualize
This repository contains useful notebook examples on how to extract and visualize
breast cancer data from the World Health Organization (WHO) database.

## Setup
## Dependencies

A python package without useful utility tools was developed to aid extraction
and visualization. The package is compatible with `Python >= 3.8` and has the
following dependencies:
The Notebooks were tested against Python 3.8 on macOS operating system. However, they should be
quite robust against different setups. The following dependencies were used, and are
installed directly through the notebooks:

* numpy

* folium

* pycountry

* geopandas

* Pillow

Note that these dependencies will be installed directly when launching the Jypyter Notebooks.

## Installation

Start by creating a virtual environment and installing the package:

```
virtualenv -ppython3 venv --clear
source venv/bin/activate
python3 -m pip install who_extract@https://github.com/andreped/breast-cancer-stats.git
```
* pandas
* plotly
* nbformat
* kaleido

## Usage

Example application notebooks are available in the [apps/](https://github.com/andreped/breast-cancer-stats/apps/) directory.

## Troubleshoot

1) Virtual environment activation

To activate the virtual environment on Windows, instead of `source venv/bin/activate` run `./venv/Scripts/activate`.

2) `ImportError: No module named selenium`
Example application notebooks are available in the [apps/](https://github.com/andreped/breast-cancer-stats/apps/) directory, and include:

To export the generated map as a PNG image, the [Firefox](https://www.mozilla.org/en-US/firefox/new/) explorer is required.
| Use case | Notebook |
| Incidence rate world map | [https://github.com/andreped/breast-cancer-stats/blob/main/apps/breast_cancer_incidence_rate_plotly.ipynb] |
| Mortality rate world map | b |
| Overall cancer statistics | [https://github.com/andreped/breast-cancer-stats/blob/main/apps/breast_cancer_incidence_rate_plotly.ipynb] |

## License

Expand Down
Loading

0 comments on commit 871c897

Please sign in to comment.