NetworkToolbox icon indicating copy to clipboard operation
NetworkToolbox copied to clipboard

Documentation: package site or vignette

Open martinctc opened this issue 4 years ago • 2 comments

Hi there, I've come across this package that seems to have a huge wealth of tools for network analysis.

One suggestion is that it might be helpful to have a vignette or a pkgdown site to help users to navigate the functions.

Is this something that is on the roadmap?

I'd be happy to fork and create a PR for setting up a pkgdown site if this aligns with the plans for this package.

martinctc avatar Dec 09 '20 12:12 martinctc

Hi @martinctc,

I've published a tutorial in The R Journal; however, this was limited in scope and does not feature many functions that have been added since then.

It is something on the roadmap. Unfortunately, I do not have a timetable.

Thanks for checking in, Alex

AlexChristensen avatar Dec 09 '20 13:12 AlexChristensen

Sounds great! If you are happy with this I can a create a PR. Just as an example of what I'm thinking of, I recently created one for one of my R packages here: https://martinctc.github.io/rwa If you have other plans then I will leave it to you, just a suggestion! :smile:

martinctc avatar Dec 09 '20 13:12 martinctc