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

Package experience for new user? #463

Open
athowes opened this issue May 15, 2024 · 1 comment
Open

Package experience for new user? #463

athowes opened this issue May 15, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@athowes
Copy link
Contributor

athowes commented May 15, 2024

Has there been any user experience testing for people new to epinowcast and perhaps to nowcasting and epidemiological modelling in general?

As I'm just looking at the README I'm met with the first line as:

Tools to enable flexible and efficient hierarchical nowcasting of right-truncated epidemiological time-series using a semi-mechanistic Bayesian model with support for a range of reporting and generative processes.

I think if you don't know what a lot of these terms mean it's going to be quite intimidating to use the package.

Perhaps it'd be good to get new users into the "Get started" vignette quicker? Rather than having to 1. read through a quite academic sounding abstract, 2. look over the folded texts about CmdStan and Docker, 3. open the folded text about vignettes.

As well, for the vignettes/epinowcast.Rmd I think this could be made more friendly to new users. As an example, the first figure in the vignette is all the way down when the model is fitted.

@seabbs
Copy link
Collaborator

seabbs commented May 15, 2024

There has been some but very little that is completely hands off (i.e with no developer interaction). I agree with all your points about surfacing a simple getting started (we used to have this in the README but it was ported to streamline things and perhaps this has gone too far).

@seabbs seabbs added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 15, 2024
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 help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

2 participants