You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Use > [!CAUTION] and other call out boxes e.g. for warning about the extent to which the package might change
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
Immediately direct users to the vignettes for the package, beginning with the "Get started"
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.
The text was updated successfully, but these errors were encountered:
* We don't have released versions!
* Likewise need to remove this
* Add citation information
* Add vignettes and CAUTION
* Better text
* Render
* Revert warning and add quickstart section
* Code fold citation
* Remove enforced breaks
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.README
#380I'd be open to more suggestions / preferences about features to include in the README and what the focus should be on.
The text was updated successfully, but these errors were encountered: