teach users to run inference app locally

SABS-R3-Epidemiology / branchpro

Using branching processes to estimate the time-dependent reproduction number of a disease with imported cases

BSD 3-Clause "New" or "Revised" License

4 stars 1 forks source link

teach users to run inference app locally #236

Closed rccreswell closed 2 months ago

rccreswell commented 4 months ago

We link to the app landing page in the first section of the 2022 paper (and some other places I have recently mentioned this...) so I think we should try and avoid having a flagrant broken link from the heroku.

Obviously it would be ideal to do another deployment, but as a makeshift solution I would suggest just instructing them how to run the app locally using the package, which is what this PR implements, but happy to hear any other suggestions.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (f7f43ef) to head (d46e099).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #236 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 13 13 Lines 1174 1172 -2 ========================================= - Hits 1174 1172 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rccreswell commented 2 months ago

In the index.html file, it is not clear which link you are referring to in "see Github link below". Also, we could emphasise that this method is used to run the app locally by making a minor change to 'To access the app locally in your browser'.

Thank you for your suggestions, I reordered it to hopefully be slightly clearer