insightsengineering/scda

"getting started" vignette

Closed this issue · 3 comments

pawelru commented

For some of the user-facing packages we need to have a "getting started" vignette that introduces users to the package, what it is about and what's the content. I assume it's a little bit more than what's in README and it's dedicated for inexperienced users.

[TBD] The content (might not be suitable for all repos):

  • description (a little longer than overview in README)
  • content / main features
  • example use cases
nikolas-burkoff commented

@pawelru

This is the README - is there really anything else to warrant a new vignette?

image

nikolas-burkoff commented

Further to the above comment, as scda is only a test data package - the only time users will use it will be to run examples from other packages - I think the readme has all the information end users need. @pawelru I'll close this unless you have further comments

nikolas-burkoff commented

Closing after stand up - won't do