Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to README #132

Closed
1 of 5 tasks
Tracked by #206
athowes opened this issue Jun 27, 2024 · 1 comment · Fixed by #387
Closed
1 of 5 tasks
Tracked by #206

Updates to README #132

athowes opened this issue Jun 27, 2024 · 1 comment · Fixed by #387
Labels
documentation Improvements or additions to documentation high Required for next release

Comments

@athowes
Copy link
Collaborator

athowes commented Jun 27, 2024

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.

  • Remove dead links from README #380
  • 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.

@athowes athowes added the documentation Improvements or additions to documentation label Jun 27, 2024
@seabbs
Copy link
Contributor

seabbs commented Jun 28, 2024

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

@athowes athowes added the high Required for next release label Aug 8, 2024
@athowes athowes mentioned this issue Aug 8, 2024
18 tasks
athowes added a commit that referenced this issue Oct 15, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation high Required for next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants