{"id":16572319,"url":"https://github.com/jonocarroll/volunteervignettes","last_synced_at":"2025-10-14T04:48:40.983Z","repository":{"id":71014128,"uuid":"120691716","full_name":"jonocarroll/VolunteerVignettes","owner":"jonocarroll","description":"The world needs more #rstats vignettes, so I'll be the change I want to see","archived":false,"fork":false,"pushed_at":"2024-02-12T04:22:32.000Z","size":48170,"stargazers_count":9,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-01T21:05:39.389Z","etag":null,"topics":["rstats","vignette"],"latest_commit_sha":null,"homepage":"https://twitter.com/carroll_jono/status/961139524901527552","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonocarroll.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-02-08T00:58:06.000Z","updated_at":"2024-02-12T04:22:36.000Z","dependencies_parsed_at":"2024-02-12T05:38:42.246Z","dependency_job_id":null,"html_url":"https://github.com/jonocarroll/VolunteerVignettes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonocarroll%2FVolunteerVignettes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonocarroll%2FVolunteerVignettes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonocarroll%2FVolunteerVignettes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonocarroll%2FVolunteerVignettes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonocarroll","download_url":"https://codeload.github.com/jonocarroll/VolunteerVignettes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238758190,"owners_count":19525722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rstats","vignette"],"created_at":"2024-10-11T21:27:09.384Z","updated_at":"2025-10-14T04:48:35.944Z","avatar_url":"https://github.com/jonocarroll.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VolunteerVignettes\n\nThe world needs more #rstats vignettes, so I'll be the change I want to see\n\n# Automatic Conversion\n\nOne option is to convert existing `README.Rmd` files into vignettes; they typically contain a wealth of information which isn't actually contained within the package.\n\nI've written a patch to the `usethis` package to allow for this; there are a few complications to navigate and I doubt I've correctly identified 100% of them. This will soon be submitted as a PR.\n\nWith the patched version installed, it's as simple as \n\n```r\n\u003e usethis::README_to_vignette()\n✔ Adding 'knitr' to Suggests field in DESCRIPTION\n✔ Setting VignetteBuilder field in DESCRIPTION to 'knitr'\n✔ Adding 'rmarkdown' to Suggests field in DESCRIPTION\n✔ Creating 'vignettes/'\n✔ Adding '*.html', '*.R' to 'vignettes/.gitignore'\n✔ Adding 'inst/doc' to './.gitignore'\n✔ Creating 'vignettes/readme-vignette.Rmd'\n● Modify 'readme-vignette.Rmd'\n```\n\nThe author is extracted from the `DESCRIPTION` file, the title is set as the package title, and the relevant YAML is updated. Nothing too fancy, but it gets the ball rolling. It seems to do an okay job on some packages which have nice `README.md` files but no vignette: \n\n* [r-lib/fs](https://jonocarroll.github.io/VolunteerVignettes/fs/fs-README-vignette.html)\n\n* [shabbychef/mazealls](https://jonocarroll.github.io/VolunteerVignettes/mazealls/mazealls-README-vignette.html)\n\n* [thomasp85/patchwork](https://jonocarroll.github.io/VolunteerVignettes/patchwork/patchwork-README-vignette.html)\n\n* [alexpghayes/formulize](https://jonocarroll.github.io/VolunteerVignettes/formulize/formulize-README-vignette.html)\n\n* [ThinkR-open/remedy](https://jonocarroll.github.io/VolunteerVignettes/remedy/remedy-README-vignette.html) (large file size warning; lots of embedded gifs)\n\nPerforming these conversions highlighted some issues with the process, even after careful treatment; mainly images in unexpected (to the vignette) places. But it also highlighted some neat issues with the READMEs themselves; packages used in the `README` which weren't marked as `Import`/`Suggests`, and image locations not existing. In theory more could be wrong; there is nothing stopping the `README` from becomming stale. Vignettes are built on install, so something should get flagged either on local check/build/install or during continuous integration testing.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonocarroll%2Fvolunteervignettes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonocarroll%2Fvolunteervignettes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonocarroll%2Fvolunteervignettes/lists"}