search

signaturescience / focustools

Forecasting COVID-19 in the US
https://signaturescience.github.io/focustools/
GNU General Public License v3.0
0 stars 0 forks source link

vignette for basic usage #58

Closed vpnagraj closed 3 years ago

vpnagraj commented 3 years ago

at the very least we should include a vignette with some narrative and an example of basic usage.

similar to what we have in "usage" section of README now?

https://github.com/signaturescience/focustools#usage

add examples / context for submission prep and visualization (see validate_forecast, submission_summary, plot_forecast, focus_explorer) ?

FWIW after we put together that vignette i'm going to trim down the contents of the README considerably.

@stephenturner assigning to you to take a first cut. i'll chip in after you've pushed to cosmetics

stephenturner commented 3 years ago

What's your preference? Commit directly to cosmetics branch or branch off and PR to cosmetics?

vpnagraj commented 3 years ago

direct on cosmetics is fine. think im just about done with everything else i was going to do there

vpnagraj commented 3 years ago

btw probably should have mentioned that i have been taking out some of the stale functionality via the cosmetics branch.

doubt you would have included this in the vignette anyways, but of note:

https://github.com/signaturescience/focustools/commit/a6ded73c409255411accc7a62ac1a526afaffe6d

https://github.com/signaturescience/focustools/commit/e637ac061fef15228ad2f527556512797317e224

vpnagraj commented 3 years ago

vignette looks good. merged in via #56