cynkra/munch

Documentation

Opened this issue · 1 comments

krlmlr commented

is rather terse right now, we need much more. With examples and perhaps a walkthrough.

andreranza commented

Try to share some ideas as they pop up on what might be done to enhance docs (some of this things might already be there and I do not have realised it yet):

  • Minor issue: probably I would make immediate for the user how he can fetch tables mentioned in vignettes/data.Rmd. Something like: "These two representations can be obtained programatically using the function swc_get_merger_mapping_table()"

  • In the data vignette add toy examples of all the types of representations that one can get using the different functions? This might an easy thing to do using the tribbles contained in tests

  • In a (dedicated?) vignette show how to use dplyr and functions contained in the package to ask common questions, such as: "how many mergers have occurred in canton xyz until Jan 1st, 2020?" (probably move some of the examples contained in the functions docs but using dplyr instead of base R?)