{"id":14066581,"url":"https://github.com/FRBCesab/rcompendium","last_synced_at":"2025-07-29T23:31:34.336Z","repository":{"id":62459024,"uuid":"339998557","full_name":"FRBCesab/rcompendium","owner":"FRBCesab","description":":package: Create a package or compendium structure","archived":false,"fork":false,"pushed_at":"2025-02-07T15:19:49.000Z","size":7347,"stargazers_count":39,"open_issues_count":5,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-25T00:54:07.564Z","etag":null,"topics":["package","r","reproducible-research","research-compendium"],"latest_commit_sha":null,"homepage":"https://frbcesab.github.io/rcompendium","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FRBCesab.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json","zenodo":null}},"created_at":"2021-02-18T09:28:40.000Z","updated_at":"2025-03-22T08:13:36.000Z","dependencies_parsed_at":"2024-01-14T19:13:16.832Z","dependency_job_id":"b5640b82-64ff-4c73-b033-51cfc3959dfb","html_url":"https://github.com/FRBCesab/rcompendium","commit_stats":{"total_commits":232,"total_committers":2,"mean_commits":116.0,"dds":"0.017241379310344862","last_synced_commit":"196985414d6e7e45576335f6bfb8c04f2609a4e2"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/FRBCesab/rcompendium","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FRBCesab%2Frcompendium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FRBCesab%2Frcompendium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FRBCesab%2Frcompendium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FRBCesab%2Frcompendium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FRBCesab","download_url":"https://codeload.github.com/FRBCesab/rcompendium/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FRBCesab%2Frcompendium/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267779979,"owners_count":24143200,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["package","r","reproducible-research","research-compendium"],"created_at":"2024-08-13T07:05:10.344Z","updated_at":"2025-07-29T23:31:33.428Z","avatar_url":"https://github.com/FRBCesab.png","language":"R","readme":"---\noutput: github_document\n---\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\n\nrcompendium \u003cimg src=\"man/figures/logo.png\" align=\"right\" style=\"float:right; height:120px;\"/\u003e\n=========================================================\n\n\n\n\u003c!-- badges: start --\u003e\n[![CRAN status](https://www.r-pkg.org/badges/version/rcompendium)](https://CRAN.R-project.org/package=rcompendium/)\n[![R CMD check](https://github.com/FRBCesab/rcompendium/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FRBCesab/rcompendium/actions/workflows/R-CMD-check.yaml)\n[![Website deployment](https://github.com/FRBCesab/rcompendium/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/FRBCesab/rcompendium/actions/workflows/pkgdown.yaml)\n[![codecov](https://codecov.io/gh/FRBCesab/rcompendium/branch/main/graph/badge.svg)](https://app.codecov.io/gh/FRBCesab/rcompendium)\n[![License: GPL (\u003e= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)\n\u003c!-- badges: end --\u003e\n\n\n\nIn the area of open science, making reproducible analyses is a strong prerequisite.\nBut sometimes it is difficult 1) to find the good structure to organize files \nand 2) to set up the whole project. The aim of the package `rcompendium` is to \nmake easier the creation of R package/research compendium (i.e. a predefined \nfiles/folders structure) so that users can focus on the code/analysis instead of \nwasting time organizing files. \n\n\nA full ready-to-work structure will be set up with the following features: \n\n- Initialization of version control with [git](https://git-scm.com/).\n- Creation of a minimal R package structure (`DESCRIPTION` and `NAMESPACE` files, \nand `R/` and `man/` folders).\n- Creation of additional files (`LICENSE.md`, `inst/CITATION`, etc.).\n- Creation of a _Get started_ vignette in `vignettes/` (package only).\n- Setting the units tests process in `tests/`.\n- Creation of a `README.Rmd` with HexSticker (template) and badges.\n- Autocompletion of maintainer information.\n- Initialization of the `renv` system (if required).\n- Creation of a Dockerfile (if required).\n- Creation of a GitHub repository.\n- Configuration of GitHub Actions to automatically:\n  - check and test package (`R CMD Check`);\n  - report the code coverage (`covr`);\n  - build and deploy website (`pkgdown`);\n  - render `README.md`.\n\n\nThis package heavily relies on the R packages \n[`devtools`](https://devtools.r-lib.org) and \n[`usethis`](https://usethis.r-lib.org) and follows recommendations made by\n[Hadley Wickham \u0026 Jenny Bryan](https://r-pkgs.org) and \n[Ben Marwick](https://peerj.com/preprints/3192/).\n\n\n\n\n## Installation\n\n\n\nYou can install the stable version from [CRAN](https://cran.r-project.org/) with:\n\n```{r eval=FALSE}\n## Install stable version of \u003c rcompendium \u003e from CRAN ----\ninstall.packages(\"rcompendium\")\n```\n\n\nOr you can install the development version from [GitHub](https://github.com/) with:\n\n```{r eval=FALSE}\n## Install \u003c remotes \u003e package (if not already installed) ----\nif (!requireNamespace(\"remotes\", quietly = TRUE)) {\n  install.packages(\"remotes\")\n}\n\n## Install dev version of \u003c rcompendium \u003e from GitHub ----\nremotes::install_github(\"FRBCesab/rcompendium\")\n```\n\n**Note:** On Unix system you may have an error during the installation linked \nto the [**V8 JavaScript engine**](https://v8.dev/). This software is required \nby the R package [`cffr`](https://docs.ropensci.org/cffr/) \n(included in `rcompendium`). Run the following line and try to reinstall `rcompendium`.\n\n```{r eval=FALSE}\n## Fix V8 issues ----\nSys.setenv(DOWNLOAD_STATIC_LIBV8 = 1)\n\n## Install \u003c rcompendium \u003e ----\ninstall.packages(\"rcompendium\")\n```\n\n\n## Usage\n\n\n\nPlease read the \n[Get started](https://frbcesab.github.io/rcompendium/articles/rcompendium.html) vignette\nand pay attention to the sections \n[Prerequisites](https://frbcesab.github.io/rcompendium/articles/rcompendium.html#prerequisites) and\n[Usage](https://frbcesab.github.io/rcompendium/articles/rcompendium.html#usage)\n\nOthers available vignettes:\n\n- [Developing a Package](https://frbcesab.github.io/rcompendium/articles/developing_a_package.html)\n- [Working with a Compendium](https://frbcesab.github.io/rcompendium/articles/working_with_a_compendium.html)\n\n\n\n## Citation\n\n\n\nPlease cite this package as: \n\n\u003e Casajus N. (2023) rcompendium: An R package to create a package or research \ncompendium structure. Version 1.3, https://github.com/FRBCesab/rcompendium.\n\nYou can also run:\n\n```{r eval=FALSE}\ncitation(\"rcompendium\")\n\n## A BibTeX entry for LaTeX users is:\n## \n## @Manual{,\n##   title  = {{rcompendium}: {An} {R} package to create a package or research compendium structure},\n##   author = {{Casajus N.}},\n##   year   = {2023},\n##   note   = {R package version 1.3},\n##   url    = {https://github.com/FRBCesab/rcompendium},\n## }\n```\n\n\n\n## Contributing\n\n\n\nAll types of contributions are encouraged and valued. For more information, \ncheck out our [Contribution Guidelines](https://github.com/FRBCesab/rcompendium/blob/main/CONTRIBUTING.md).\n\nPlease note that the `rcompendium` project is released with a \n[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). \nBy contributing to this project, you agree to abide by its terms.\n\n\n\n\n## Colophon\n\n\n\nThis package is the result of intense discussions and feedbacks from the training \ncourse [Reproducible Research in Computational Ecology](https://rdatatoolbox.github.io/). \n\n`rcompendium` is largely inspired by the package \n[`rrtools`](https://github.com/benmarwick/rrtools) developed by \n[Ben Marwick _et al._](https://github.com/benmarwick) and tries to respect the standard \ndefined by the community.\n","funding_links":[],"categories":["R"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFRBCesab%2Frcompendium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFRBCesab%2Frcompendium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFRBCesab%2Frcompendium/lists"}