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

Create pkgdown site #23

Open
JosiahParry opened this issue Jun 30, 2022 · 1 comment
Open

Create pkgdown site #23

JosiahParry opened this issue Jun 30, 2022 · 1 comment

Comments

@JosiahParry
Copy link

Hi there, I've recently discovered the synthpop (great name) package for creating synthetic datasets. However, I am finding it very difficult to get started with the package. The synthpop website, while beautiful in its own right, does not make accessing the package easy. The resource that are linked are mostly journal articles. It would be great if there were a website with an easy to navigate reference page and easy to read vignettes. While I can consume the vignettes, they are written as if they are tailored to an academic journal, not for new users of the package.

As a feature request, I'd ask for a pkgdown site to be created. Further enhancements would be simple vignettes that explain the basic utility of the package in a syntactic style that can be consumed just as easily at 11pm on the couch or 8:30am with a fresh cup of coffee.

@gillian-raab
Copy link

Dear Josiah,
Sorry you are getting stuck. Are you running R via R studio. There is a lot of example code with all of our functions. ALso, did you visit the getting started bit of the synthpop website. There is a link there to an R script called https://www.synthpop.org.uk/assets/firstsynthesis.r, that might help you get started. II didn't know what a pkgdown web site was until now, though the examples I have found there look interesting and helpful. Have you used it yourself? Maybe you could help us make one for synthpop.
Best wishes and thanks for feedback Gillian Raab

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

No branches or pull requests

2 participants