{ "_id": "6a105cf8acfb0bcc41ca4653", "Package": "rcompendium", "Type": "Package", "Title": "Create a Package or Research Compendium Structure", "Version": "2.0.0.9000", "Authors@R": "c(\nperson(given = \"Nicolas\",\nfamily = \"Casajus\",\nrole = c(\"aut\", \"cre\", \"cph\"),\nemail = \"nicolas.casajus@fondationbiodiversite.fr\",\ncomment = c(ORCID = \"0000-0002-5537-5294\")))", "Description": "Makes easier the creation of R package or research\ncompendium (i.e. a predefined files/folders structure) so that\nusers can focus on the code/analysis instead of wasting time\norganizing files. A full ready-to-work structure is set up with\nsome additional features: version control, remote repository\ncreation, CI/CD configuration (check package integrity under\nseveral OS, test code with 'testthat', and build and deploy\nwebsite using 'pkgdown'). This package heavily relies on the R\npackages 'devtools' and 'usethis' and follows recommendations\nmade by Wickham H. (2015) and Marwick B.\net al. (2018) .", "URL": "https://github.com/FRBCesab/rcompendium,\nhttps://frbcesab.github.io/rcompendium/", "BugReports": "https://github.com/FRBCesab/rcompendium/issues", "License": "GPL (>= 2)", "Encoding": "UTF-8", "Roxygen": "list(markdown = TRUE)", "VignetteBuilder": "knitr", "Config/testthat/edition": "3", "Config/roxygen2/version": "8.0.0", "Config/pak/sysreqs": "cmake libfontconfig1-dev libfreetype6-dev\nlibfribidi-dev git make libharfbuzz-dev libgit2-dev libicu-dev\nlibjpeg-dev libpng-dev libtiff-dev libuv1-dev libwebp-dev\nlibxml2-dev libssl-dev libx11-dev zlib1g-dev", "Repository": "https://frbcesab.r-universe.dev", "Date/Publication": "2026-05-08 05:22:06 UTC", "RemoteUrl": "https://github.com/FRBCesab/rcompendium", "RemoteRef": "HEAD", "RemoteSha": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "NeedsCompilation": "no", "Packaged": { "Date": "2026-05-09 04:54:04 UTC", "User": "root" }, "Author": "Nicolas Casajus [aut, cre, cph] (ORCID:\n)", "Maintainer": "Nicolas Casajus ", "MD5sum": "b1d2cb2b6aab0ca6e4fedddee43a4d52", "_user": "frbcesab", "_type": "src", "_file": "rcompendium_2.0.0.9000.tar.gz", "_fileid": "d6888ef3d876fd6b88ec99b602beb759b668da6fe9c0ba64566b788b69babba3", "_filesize": 658850, "_sha256": "d6888ef3d876fd6b88ec99b602beb759b668da6fe9c0ba64566b788b69babba3", "_created": "2026-05-09T04:54:04.000Z", "_published": "2026-05-22T13:41:12.226Z", "_distro": "noble", "_jobs": [ { "job": 77391345048, "time": 169, "config": "linux-devel-x86_64", "r": "4.7.0", "check": "ERROR", "artifact": "6892989598" }, { "job": 77391345611, "time": 167, "config": "linux-release-x86_64", "r": "4.6.0", "check": "ERROR", "artifact": "6892989404" }, { "job": 77391345877, "time": 117, "config": "macos-oldrel-arm64", "r": "4.5.3", "check": "NOTE", "artifact": "6892984187" }, { "job": 77391345355, "time": 124, "config": "macos-release-arm64", "r": "4.6.0", "check": "NOTE", "artifact": "6892984814" }, { "job": 77391344505, "time": 196, "config": "source", "r": "4.6.0", "check": "OK", "artifact": "6892973956" }, { "job": 77391344612, "time": 137, "config": "wasm-release", "r": "4.6.0", "check": "OK", "artifact": "7161930118" }, { "job": 77391345203, "time": 113, "config": "windows-devel", "r": "4.7.0", "check": "NOTE", "artifact": "6892983955" }, { "job": 77391345360, "time": 121, "config": "windows-oldrel", "r": "4.5.3", "check": "NOTE", "artifact": "6892984591" }, { "job": 77391345236, "time": 113, "config": "windows-release", "r": "4.6.0", "check": "NOTE", "artifact": "6892983990" } ], "_buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360", "_status": "success", "_host": "GitHub-Actions", "_upstream": "https://github.com/FRBCesab/rcompendium", "_commit": { "id": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "author": "ahasverus ", "committer": "ahasverus ", "message": "doc: update CITATION.cff\n", "time": 1778217726 }, "_maintainer": { "name": "Nicolas Casajus", "email": "nicolas.casajus@fondationbiodiversite.fr", "login": "ahasverus", "uuid": 10423581, "orcid": "0000-0002-5537-5294" }, "_registered": true, "_dependencies": [ { "package": "R", "version": ">= 2.10", "role": "Depends" }, { "package": "cli", "role": "Imports" }, { "package": "devtools", "role": "Imports" }, { "package": "gert", "role": "Imports" }, { "package": "gh", "role": "Imports" }, { "package": "gtools", "role": "Imports" }, { "package": "httr2", "role": "Imports" }, { "package": "renv", "role": "Imports" }, { "package": "rmarkdown", "role": "Imports" }, { "package": "roxygen2", "role": "Imports" }, { "package": "rprojroot", "role": "Imports" }, { "package": "stringr", "role": "Imports" }, { "package": "usethis", "role": "Imports" }, { "package": "utils", "role": "Imports" }, { "package": "fs", "role": "Suggests" }, { "package": "knitr", "role": "Suggests" }, { "package": "testthat", "version": ">= 3.0.0", "role": "Suggests" }, { "package": "vcr", "role": "Suggests" }, { "package": "withr", "role": "Suggests" } ], "_owner": "frbcesab", "_selfowned": true, "_usedby": 0, "_updates": [ { "week": "2025-36", "n": 3 }, { "week": "2026-17", "n": 26 }, { "week": "2026-18", "n": 1 }, { "week": "2026-19", "n": 5 } ], "_tags": [ { "name": "v1.4", "date": "2025-09-02" } ], "_topics": [ "reproducible-research", "research-compendium" ], "_stars": 40, "_contributors": [ { "user": "ahasverus", "count": 421, "uuid": 10423581 }, { "user": "khammami", "count": 10, "uuid": 297917 }, { "user": "olivroy", "count": 5, "uuid": 52606734 } ], "_userbio": { "uuid": 56294308, "type": "organization", "name": "FRB CESAB" }, "_downloads": { "count": 843, "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/rcompendium" }, "_devurl": "https://github.com/frbcesab/rcompendium", "_pkgdown": "https://frbcesab.github.io/rcompendium/", "_searchresults": 27, "_rbuild": "4.6.0", "_assets": [ "extra/citation.cff", "extra/citation.html", "extra/citation.json", "extra/citation.txt", "extra/contents.json", "extra/NEWS.html", "extra/NEWS.txt", "extra/rcompendium.html", "extra/readme.html", "extra/readme.md", "manual.pdf" ], "_homeurl": "https://github.com/frbcesab/rcompendium", "_realowner": "frbcesab", "_cranurl": true, "_releases": [ { "version": "0.5.1", "date": "2021-03-24" }, { "version": "1.0", "date": "2022-04-06" }, { "version": "1.1", "date": "2023-04-24" }, { "version": "1.2", "date": "2023-10-24" }, { "version": "1.3", "date": "2023-10-26" }, { "version": "1.4", "date": "2025-09-02" } ], "_exports": [ "add_citation", "add_code_of_conduct", "add_codecov_badge", "add_codeowners", "add_compendium", "add_contributing", "add_cran_downloads_badge", "add_cran_total_download_badge", "add_cran_version_badge", "add_dependabot", "add_dependencies", "add_dependencies_badge", "add_description", "add_dockerfile", "add_github_action", "add_github_actions_check_badge", "add_github_actions_codecov_badge", "add_github_actions_pkgdown_badge", "add_issue_template", "add_license", "add_license_badge", "add_lifecycle_badge", "add_makefile", "add_package_doc", "add_r_depend", "add_readme_rmd", "add_renv", "add_repostatus_badge", "add_testthat", "add_to_buildignore", "add_to_gitignore", "add_vignette", "create_new_compendium", "create_new_package", "get_all_dependencies", "get_all_functions", "get_available_gh_actions", "get_available_issue_templates", "get_available_licenses", "get_minimal_r_version", "set_credentials" ], "_help": [ { "page": "add_citation", "title": "Create a CITATION file", "concept": [ "create files" ], "topics": [ "add_citation" ] }, { "page": "add_code_of_conduct", "title": "Add a CODE OF CONDUCT file", "concept": [ "create files" ], "topics": [ "add_code_of_conduct" ] }, { "page": "add_codecov_badge", "title": "Add a Codecov badge", "concept": [ "adding badges" ], "topics": [ "add_codecov_badge" ] }, { "page": "add_codeowners", "title": "Create a CODEOWNERS file", "concept": [ "create files" ], "topics": [ "add_codeowners" ] }, { "page": "add_compendium", "title": "Create additional folders", "concept": [ "create files" ], "topics": [ "add_compendium" ] }, { "page": "add_contributing", "title": "Add a CONTRIBUTING file", "concept": [ "create files" ], "topics": [ "add_contributing" ] }, { "page": "add_cran_downloads_badge", "title": "Add CRAN monthly downloads badge", "concept": [ "adding badges" ], "topics": [ "add_cran_downloads_badge" ] }, { "page": "add_cran_total_download_badge", "title": "Add CRAN total download badge", "concept": [ "adding badges" ], "topics": [ "add_cran_total_download_badge" ] }, { "page": "add_cran_version_badge", "title": "Add a CRAN version badge", "concept": [ "adding badges" ], "topics": [ "add_cran_version_badge" ] }, { "page": "add_dependabot", "title": "Add a DEPENDABOT file", "concept": [ "development functions" ], "topics": [ "add_dependabot" ] }, { "page": "add_dependencies", "title": "Add dependencies in DESCRIPTION", "concept": [ "development functions" ], "topics": [ "add_dependencies" ] }, { "page": "add_dependencies_badge", "title": "Add a Dependencies badge", "concept": [ "adding badges" ], "topics": [ "add_dependencies_badge" ] }, { "page": "add_description", "title": "Add a DESCRIPTION file", "concept": [ "create files" ], "topics": [ "add_description" ] }, { "page": "add_dockerfile", "title": "Create a Dockerfile", "concept": [ "create files" ], "topics": [ "add_dockerfile" ] }, { "page": "add_github_action", "title": "Set up a GitHub Action workflow", "concept": [ "development functions" ], "topics": [ "add_github_action" ] }, { "page": "add_github_actions_check_badge", "title": "Add a R CMD Check badge", "concept": [ "adding badges" ], "topics": [ "add_github_actions_check_badge" ] }, { "page": "add_github_actions_codecov_badge", "title": "Add a Test coverage badge", "concept": [ "adding badges" ], "topics": [ "add_github_actions_codecov_badge" ] }, { "page": "add_github_actions_pkgdown_badge", "title": "Add a Website badge", "concept": [ "adding badges" ], "topics": [ "add_github_actions_pkgdown_badge" ] }, { "page": "add_issue_template", "title": "Set up an Issue Template file", "concept": [ "development functions" ], "topics": [ "add_issue_template" ] }, { "page": "add_license", "title": "Add a LICENSE file", "concept": [ "create files" ], "topics": [ "add_license" ] }, { "page": "add_license_badge", "title": "Add a License badge", "concept": [ "adding badges" ], "topics": [ "add_license_badge" ] }, { "page": "add_lifecycle_badge", "title": "Add a Life Cycle badge", "concept": [ "adding badges" ], "topics": [ "add_lifecycle_badge" ] }, { "page": "add_makefile", "title": "Create a Make-like R file", "concept": [ "create files" ], "topics": [ "add_makefile" ] }, { "page": "add_package_doc", "title": "Create a package-level documentation file", "concept": [ "create files" ], "topics": [ "add_package_doc" ] }, { "page": "add_r_depend", "title": "Add minimal R version to DESCRIPTION", "concept": [ "development functions" ], "topics": [ "add_r_depend" ] }, { "page": "add_readme_rmd", "title": "Create a README file", "concept": [ "create files" ], "topics": [ "add_readme_rmd" ] }, { "page": "add_renv", "title": "Initialize renv", "concept": [ "create files" ], "topics": [ "add_renv" ] }, { "page": "add_repostatus_badge", "title": "Add a Repository Status badge", "concept": [ "adding badges" ], "topics": [ "add_repostatus_badge" ] }, { "page": "add_testthat", "title": "Initialize units tests", "concept": [ "create files" ], "topics": [ "add_testthat" ] }, { "page": "add_to_buildignore", "title": "Add to the .Rbuildignore file", "concept": [ "development functions" ], "topics": [ "add_to_buildignore" ] }, { "page": "add_to_gitignore", "title": "Add to the .gitignore file", "concept": [ "development functions" ], "topics": [ "add_to_gitignore" ] }, { "page": "add_vignette", "title": "Create a vignette document", "concept": [ "create files" ], "topics": [ "add_vignette" ] }, { "page": "create_new_compendium", "title": "Create an R compendium structure", "concept": [ "setup functions" ], "topics": [ "create_new_compendium" ] }, { "page": "create_new_package", "title": "Create an R package structure", "concept": [ "setup functions" ], "topics": [ "create_new_package" ] }, { "page": "get_all_dependencies", "title": "Get all external dependencies", "concept": [ "utilities functions" ], "topics": [ "get_all_dependencies" ] }, { "page": "get_all_functions", "title": "List all functions in the package", "concept": [ "utilities functions" ], "topics": [ "get_all_functions" ] }, { "page": "get_available_gh_actions", "title": "List available GitHub Actions", "concept": [ "utilities functions" ], "topics": [ "get_available_gh_actions" ] }, { "page": "get_available_issue_templates", "title": "List available ISSUE TEMPLATE", "concept": [ "utilities functions" ], "topics": [ "get_available_issue_templates" ] }, { "page": "get_available_licenses", "title": "List all available licenses", "concept": [ "utilities functions" ], "topics": [ "get_available_licenses" ] }, { "page": "get_minimal_r_version", "title": "Get required minimal R version", "concept": [ "utilities functions" ], "topics": [ "get_minimal_r_version" ] }, { "page": "set_credentials", "title": "Store user information in the .Rprofile", "concept": [ "setup functions" ], "topics": [ "set_credentials" ] } ], "_pkglogo": "https://github.com/FRBCesab/rcompendium/raw/HEAD/man/figures/logo.png", "_readme": "https://github.com/FRBCesab/rcompendium/raw/HEAD/README.md", "_rundeps": [ "askpass", "base64enc", "brew", "brio", "bslib", "cachem", "callr", "cli", "clipr", "commonmark", "cpp11", "crayon", "credentials", "curl", "desc", "devtools", "diffobj", "digest", "downlit", "ellipsis", "evaluate", "fansi", "fastmap", "fontawesome", "fs", "gert", "gh", "gitcreds", "glue", "gtools", "highr", "htmltools", "htmlwidgets", "httpuv", "httr2", "ini", "jquerylib", "jsonlite", "knitr", "later", "lifecycle", "magrittr", "memoise", "mime", "miniUI", "openssl", "otel", "pak", "pillar", "pkgbuild", "pkgconfig", "pkgdown", "pkgload", "praise", "prettyunits", "processx", "profvis", "promises", "ps", "purrr", "R6", "ragg", "rappdirs", "rcmdcheck", "Rcpp", "renv", "rlang", "rmarkdown", "roxygen2", "rprojroot", "rstudioapi", "rversions", "sass", "sessioninfo", "shiny", "sourcetools", "stringi", "stringr", "sys", "systemfonts", "testthat", "textshaping", "tibble", "tinytex", "urlchecker", "usethis", "utf8", "vctrs", "waldo", "whisker", "withr", "xfun", "xml2", "xopen", "xtable", "yaml", "zip" ], "_vignettes": [ { "source": "developing_a_package.Rmd", "filename": "developing_a_package.html", "title": "Developing an R package", "engine": "knitr::rmarkdown", "headings": [ "Package content", "Package metadata", "DESCRIPTION", "README", "Recommended workflow", "Resources" ], "created": "2022-03-26 09:34:41", "modified": "2026-04-26 08:52:04", "commits": 8 }, { "source": "rcompendium.Rmd", "filename": "rcompendium.html", "title": "Get started with rcompendium", "engine": "knitr::rmarkdown", "headings": [ "Prerequisites", "GIT configuration", "Creating a GitHub repo", "Managing credentials", "Usage", "Resources", "Contributing", "Colophon" ], "created": "2021-03-08 12:22:05", "modified": "2026-04-26 08:52:04", "commits": 13 }, { "source": "working_with_a_compendium.Rmd", "filename": "working_with_a_compendium.html", "title": "Working with a Compendium", "engine": "knitr::rmarkdown", "headings": [ "Compendium content", "Compendium metadata", "DESCRIPTION", "README", "Recommendations", "Advanced features", "Using renv", "Using docker" ], "created": "2022-03-26 09:34:41", "modified": "2026-04-26 08:52:04", "commits": 8 } ], "_score": 7.1126050015345745, "_indexed": true, "_nocasepkg": "rcompendium", "_universes": [ "frbcesab", "ahasverus" ], "_binaries": [ { "r": "4.7.0", "os": "linux", "version": "2.0.0.9000", "date": "2026-05-09T04:56:45.000Z", "distro": "noble", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "3dcb07854a06ebbd42802effe322447d4b274ec81d7647d7ea097ee0df0b6d20", "status": "failure", "check": "ERROR", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.6.0", "os": "linux", "version": "2.0.0.9000", "date": "2026-05-09T04:56:47.000Z", "distro": "noble", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "80f816a80457630e069136b4ca6329afb157ab4f1b6a325f5d744baf6d02e25e", "status": "failure", "check": "ERROR", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.5.3", "os": "mac", "version": "2.0.0.9000", "date": "2026-05-09T04:55:58.000Z", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "55137ca9ac190fb70057abb7ed5c433b46393f8b3cbfa49a85eef92b82bf0ab4", "status": "success", "check": "NOTE", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.6.0", "os": "mac", "version": "2.0.0.9000", "date": "2026-05-09T04:56:01.000Z", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "cbd1c5f28a44e65e80c9f8007425bb1f6587e31fc77d7051240c6e262952f4f2", "status": "success", "check": "NOTE", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.7.0", "os": "win", "version": "2.0.0.9000", "date": "2026-05-09T04:55:32.000Z", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "607cf513a1ddf7c6e8e3d00194a0438fdf3aba2bd8097a17e0798316b970fbb3", "status": "success", "check": "NOTE", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.5.3", "os": "win", "version": "2.0.0.9000", "date": "2026-05-09T04:55:42.000Z", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "145c69b88fb1a460907c078185d9c6c5e95fbdf81246799a1776713eddbdf3fc", "status": "success", "check": "NOTE", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.6.0", "os": "win", "version": "2.0.0.9000", "date": "2026-05-09T04:55:32.000Z", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "01b9658f0f11e17ea36f93e85bbfc630d6b3a229ca967190fca08c655963c35c", "status": "success", "check": "NOTE", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" }, { "r": "4.6.0", "os": "wasm", "version": "2.0.0.9000", "date": "2026-05-22T13:40:55.000Z", "commit": "344136811efa4a5ab7af79a16b6ea0729bfe3b14", "fileid": "d79e5b513e46939af1b9b53a3bf5118e17a6792af02a3f14ab908c58caee7270", "status": "success", "buildurl": "https://github.com/r-universe/frbcesab/actions/runs/25538830360" } ] }