Skip to content

Commit

Permalink
Added troubleshooting section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
andreped committed Aug 9, 2023
1 parent e3425ef commit 5718682
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ breast cancer data from the World Health Organization (WHO) database.

## [Examples](https://github.com/andreped/breast-cancer-stats#examples)

Example application 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/andreped/breast-cancer-stats/tree/main/apps) directory.

They can be accessed by clicking their respective colab badge below:
They can also be accessed by clicking their respective CoLab badge below:

| Use case | Notebook | Tests |
| - | - | - |
Expand All @@ -33,13 +33,19 @@ The Notebooks were tested against Python 3.8 on macOS operating system. Continuo
on Ubuntu 20.04 operating system (see [here](https://github.com/andreped/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 directly through the notebooks:
The following dependencies were used and are installed as part of the notebooks:

* [pandas](https://pypi.org/project/pandas/)
* [plotly](https://pypi.org/project/plotly/)
* [nbformat](https://pypi.org/project/nbformat/)
* [kaleido](https://pypi.org/project/kaleido/)

## [Troubleshooting](https://github.com/andreped/breast-cancer-stats#troubleshooting)

If you attempt to run the notebooks locally or view them from GitHub, the resulting image may not be displayed.
This is due to the renderer in Plotly's `show()` method being set to `show(renderer="colab")`.
By removing the specification of renderer or choosing an appropriate renderer, the resulting image should be shown in the notebook.

## [License](https://github.com/andreped/breast-cancer-stats#license)

This repository has [MIT license](https://github.com/andreped/breast-cancer-stats/blob/main/LICENSE).
Expand Down

0 comments on commit 5718682

Please sign in to comment.