{"id":21909061,"url":"https://github.com/indenkun/readme2vignette","last_synced_at":"2026-02-01T00:05:00.740Z","repository":{"id":222153054,"uuid":"756406036","full_name":"indenkun/readme2vignette","owner":"indenkun","description":"readme2vignette is to attempt to install a package GitHub or CRAN with convert README.md to Vignette during Package installation.","archived":false,"fork":false,"pushed_at":"2024-06-26T13:46:19.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-04T01:37:21.158Z","etag":null,"topics":["r"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/indenkun.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-12T15:53:50.000Z","updated_at":"2024-06-26T13:46:23.000Z","dependencies_parsed_at":"2024-06-18T03:28:08.850Z","dependency_job_id":"9b3c1f12-efec-4fc0-9f15-e87e86dafcfd","html_url":"https://github.com/indenkun/readme2vignette","commit_stats":null,"previous_names":["indenkun/readme2vignette"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/indenkun/readme2vignette","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indenkun%2Freadme2vignette","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indenkun%2Freadme2vignette/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indenkun%2Freadme2vignette/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indenkun%2Freadme2vignette/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/indenkun","download_url":"https://codeload.github.com/indenkun/readme2vignette/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indenkun%2Freadme2vignette/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28961178,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T23:03:11.038Z","status":"ssl_error","status_checked_at":"2026-01-31T22:56:44.691Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["r"],"created_at":"2024-11-28T17:15:04.152Z","updated_at":"2026-02-01T00:05:00.723Z","avatar_url":"https://github.com/indenkun.png","language":"R","funding_links":[],"categories":["Vignettes"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# readme2vignette\n\n\u003c!-- badges: start --\u003e\n\u003c!-- badges: end --\u003e\n\nThe goal of `readme2vignette` is to attempt to install a package directly GitHub or CRAN with convert `README.md` to Vignette during Package installation. \n\nBased on `remotes::install_github()` and `remotes::install_cran()` that `remotes` version 2.4.2. \n\n## Installation\n\nYou can install the released version of `readme2vignette` from CRAN with:\n\n``` r\ninstall.packages(\"readme2vignette\")\n```\n\nYou can install the development version of `readme2vignette` like so:\n\n``` r\ninstall.packages(\"remotes\")\nremotes::install_github(\"indenkun/readme2vignette\")\n```\n\n## Example\n\n### `install_cran_with_readme()`\n\nThe basic usage is the same as `remotes::install_cran()`.\n\nIf you try to install a package with README.md but no vignette from CRAN Repository using `readme2vignette::install_cran_with_readme()`, by default the argument `readme_to_vignette` is TRUE and the contents of `README.md` becomes a vignette called README.\n\nInstallation from binary packages is not supported. Installation must always be done from the sourceco package.\n\n```r\nreadme2vignette::install_github_with_readme(\"MissMech\")\n```\n\nTherefore, the contents of `README.md` can be referenced in the local environment by `vignette(\"README\", package = \"packagename\")`.\n\n```r\nvignette(\"README\", package = \"MissMech\")\n```\n\n### `install_github_with_reademe()`\n\nThe basic usage is the same as `remotes::install_github()`.\n\nIf you try to install a package with README.md but no vignette from GitHub using `readme2vignette::install_github_with_readme()`, by default the argument `readme_to_vignette` is TRUE and the contents of `README.md` becomes a vignette called README.\n\n```r\nreadme2vignette::install_github_with_readme(\"indenkun/MissMech\")\n```\n\nTherefore, the contents of `README.md` can be referenced in the local environment by `vignette(\"README\", package = \"packagename\")`.\n\n```r\nvignette(\"README\", package = \"MissMech\")\n```\n\n## Note\n\nThe `remotes` package on which this code is based was created by the author of `remotes` and is now released at MIT.\n\nThe author of the remotes package is currently listed as Developed by Gábor Csárdi, Jim Hester, Hadley Wickham, Winston Chang, Martin Morgan, Dan Tenenbaum, Posit Software, PBC.\n\nSee [r-lib/remote](https://github.com/r-lib/remotes) for detailed authorship.\n\nUnder the current specification, the images in the `README.md` are copied for the figures in the directories under `man/figures/`, but not for the images in other directories, which are missing.\n\n## License\n\nMIT\n\n## Imports packages\n\n* `desc`\n* `fs`\n* `knitr`\n* `pkgbuild`\n* `remotes`\n* `rmarkdown`\n* `usethis`\n* `utils`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findenkun%2Freadme2vignette","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findenkun%2Freadme2vignette","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findenkun%2Freadme2vignette/lists"}