search

epinowcast / epidist

An R package for estimating epidemiological delay distributions
http://epidist.epinowcast.org/
Other
9 stars 3 forks source link

Updates to README #132

Open athowes opened 1 week ago

athowes commented 1 week ago

I think that our README.Rmd file could be rewritten to provide a better introduction to the package. I think that this can wait until our "initial release" version is complete, but am writting an issue here now to log some ideas that I have.

  1. All of the links should go somewhere. Currently e.g. the code of conduct, contributing guide, Q&A are empty
  2. Use > [!CAUTION] and other call out boxes e.g. for warning about the extent to which the package might change
  3. Put the Park et al. and Charniga et al. papers more front and center for users to refer to. I can see we have a link to the model vignette which doesn't exist yet: this should be made to link up
  4. Immediately direct users to the vignettes for the package, beginning with the "Get started"
  5. Posssibly: some kind of figure, perhaps explaining in a schematic what the package does. I think this could make things a lot more visually appealing

I'd be open to more suggestions / preferences about features to include in the README and what the focus should be on.

seabbs commented 1 week ago

Posssibly: some kind of figure, perhaps explaining in a schematic what the package does. I think this could make things a lot more visually appealing

Great idea