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

Provide examples as vignettes #28

Open
jamesmbaazam opened this issue Oct 14, 2023 · 1 comment
Open

Provide examples as vignettes #28

jamesmbaazam opened this issue Oct 14, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@jamesmbaazam
Copy link

jamesmbaazam commented Oct 14, 2023

The examples provided here in a separate repo (https://github.com/HRDAG/verdata-examples) should be properly linked to this repository. One way to do that would be through package vignettes [See the vignettes section of the R Packages book]. To take this even further, it might be better to set up a website for this repository where the vignettes can be accessed as Articles. See the website chapter of the R Packages book.

I see there is a related issue here HRDAG/verdata-examples#2 to convert the examples to a human-readable format. I will leave this to the authors' discretion.

This issue is with reference to the JOSS review here openjournals/joss-reviews#5844

@thegargiulian thegargiulian self-assigned this Oct 15, 2023
@thegargiulian thegargiulian added the enhancement New feature or request label Oct 15, 2023
@thegargiulian
Copy link
Contributor

See suggestion in #30 to setup pkgdown integration when this/the examples repo is turned into a website

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

No branches or pull requests

2 participants