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

Documentation #26

Open
krlmlr opened this issue Mar 19, 2021 · 1 comment
Open

Documentation #26

krlmlr opened this issue Mar 19, 2021 · 1 comment
Milestone

Comments

@krlmlr
Copy link
Collaborator

krlmlr commented Mar 19, 2021

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

@TSchiefer TSchiefer added this to the 0.2.0 milestone Nov 30, 2021
@andreranza
Copy link
Member

andreranza commented Jun 1, 2022

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?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants