epiverse-trace / vaccineff

R package with tools for estimating vaccine effectiveness and vaccine related metrics
https://epiverse-trace.github.io/vaccineff/
Other
14 stars 2 forks source link

improve quick start guide #79

Open davidsantiagoquevedo opened 2 weeks ago

davidsantiagoquevedo commented 2 weeks ago
          The quick start does not provide sufficient information to actually get started with the package. What would be the next logical step after loading the cohortdata?

Adding some pathway to a result, even if not comprehensive or 100% accurate, is helpful to get people started. This helps build confidence and momentum in using the tool. I understand some information is provided in the "Getting started" vignette, and that is not a replacement to start building that confidence here (every extra step can lead to people checking out).

_Originally posted by @chartgerink in https://github.com/epiverse-trace/vaccineff/pull/76#discussion_r1773141727_

davidsantiagoquevedo commented 2 weeks ago

Hi @ErikaCantor. This is an important suggestion for our efforts to improve the documentation. I think we can easily address it with the resources we already have.