{"id":18918387,"url":"https://github.com/r-lum/rlumbuild","last_synced_at":"2026-02-28T10:02:53.536Z","repository":{"id":83882834,"uuid":"184582930","full_name":"R-Lum/RLumBuild","owner":"R-Lum","description":"RLum Universe Package Building","archived":false,"fork":false,"pushed_at":"2025-09-12T10:50:55.000Z","size":12521,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-12T12:35:11.478Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/R-Lum.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.Rmd","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":"codemeta.json","zenodo":null}},"created_at":"2019-05-02T13:08:10.000Z","updated_at":"2025-09-12T10:50:59.000Z","dependencies_parsed_at":"2024-03-12T15:32:00.035Z","dependency_job_id":"888e5baf-c77f-4e65-bea2-ed9af7f9a483","html_url":"https://github.com/R-Lum/RLumBuild","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/R-Lum/RLumBuild","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R-Lum%2FRLumBuild","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R-Lum%2FRLumBuild/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R-Lum%2FRLumBuild/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R-Lum%2FRLumBuild/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/R-Lum","download_url":"https://codeload.github.com/R-Lum/RLumBuild/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/R-Lum%2FRLumBuild/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29929592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T09:58:13.507Z","status":"ssl_error","status_checked_at":"2026-02-28T09:57:57.047Z","response_time":90,"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":[],"created_at":"2024-11-08T10:31:38.503Z","updated_at":"2026-02-28T10:02:53.500Z","avatar_url":"https://github.com/R-Lum.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\nheader-includes:\n   - \\usepackage{amsmath}\n   - \\usepackage{amssymb}\n---\n\u003c!-- README.md was auto-generated by README.Rmd. Please DO NOT edit by hand!--\u003e\n\n```{r, echo = FALSE, message=FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\"\n)\nlibrary(RLumBuild)\n```\n\n# RLumBuild \u003cimg width=120px src=\"man/figures/RLumBuild-logo.svg\" align=\"right\" /\u003e\n\n**Build packages from the RLum-universe. A collection of tools and scripts to unify the building of packages.**\n\n[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)\n![GitHub release](https://img.shields.io/github/release/R-Lum/RLumBuild.svg)\n![GitHub Release Date](https://img.shields.io/github/release-date/R-Lum/RLumBuild.svg)\n[![GitHub Actions CI](https://github.com/R-Lum/RLumBuild/actions/workflows/GitHub_Actions_CI.yaml/badge.svg?branch=master)](https://github.com/R-Lum/RLumBuild/actions/workflows/GitHub_Actions_CI.yaml)\n\nOver the years our RLum-package universe expanded. At the same time building and maintaining the various packages became more and more complex. While at the beginning we used tools, such as the `'devtools'` package, bugs and changes of the [CRAN](https://www.r-project.org/) requirements forced us to develop custom-tailored scripts. Those scripts where simple R-scripts loaded via `R CMD BATCH` from the terminal, however, it was tedious to handle them across different packages. On the top, we needed separate shell-scripts for all the three major OS platforms. Now 'RLumBuild` provides a unified environment to check and build our **R** packages. \n\nThe package is more than just the collection of the scripts we had developed so far. The central function is called `build_package()` and is called without further arguments. The function calls the usual check and build functions from `'devtools'` but also runs\nfurther custom modules (functions in the package 'RLumBuild'), to, e.g., add a new section 'How to cite' to \nadd function related citation information. \n\n*Note: 'RLumBuild' is no CRAN package and it will not be submitted to CRAN, since the number of potential \nusers is very small. However, as for all other packages we develop, we apply the same quality standards.* \n\n## Installation\n\n```{r, eval=FALSE}\nif(!require(\"devtools\"))\n  install.packages(\"devtools\")\ndevtools::install_github(\"R-Lum/RLumBuild@master\")\n```\n\n## Examples and how to use the package\n\nA packages builds by simply calling \n\n```{r, eval=FALSE}\nRLumBuild::build_package()\n```\n\nIn conjunction with [RStudio](https://posit.co/download/rstudio-desktop/) a \nshort bash script allowing a full integration is more useful. \n\n```{}\n#!/bin/bash\n\nR -q -e \"RLumBuild::build_package()\"\n```\n\nThis script is stored in the package directory and connected with *RStudio* via \n*Project Options \u003e\u003e Build Tools \u003e\u003e Project Build Tools \u003e\u003e [Custom]*\n\nThe function itself does not require arguments to run, however, it has arguments that \ncan be used to control the build process:  \n\n#### `  write_Rbuildignore`\n\nIf set to `TRUE` (the default) every `.Ruildignore` is overwritten by a template shipped\nwith the package. Please note that this file is highly customised to serve package building \nin the RLum-universe.\n\n#### `exclude`\n\nThe package is mainly organised in modules (basically single, documented package functions\nstaring with `modul_`). Every module serves a different process and is not essential \nto build the package but provide some additional features (e.g., automated version numbering). \nTo prevent that a particular module is called, it can be excluded using the argument `exclude`, \ne.g, the subsequent call prevents the `NEWS.md` file from being created. \n\n```{r, eval = FALSE}\nRLumBuild::build_package(exclude = c(\"module_knit_NEWS\"))\n```\n\n#### `as_cran`\n\nThis argument allows to enable/disable the `--as-cran` check.\n\n```{r, eval = FALSE}\nRLumBuild::build_package(as_cran = TRUE)\n```\n\n## License\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\nany later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n [GNU General Public License](https://github.com/R-Lum/RLumBuild/blob/master/LICENSE) for more details.\n\n## Projects using RLumBuild\n\n* [BayLum](https://github.com/crp2a/BayLum)\n* [Luminescence](https://github.com/R-Lum/Luminescence)\n* [RCarb](https://github.com/R-Lum/RCarb)\n* [RLumModel](https://github.com/R-Lum/RLumModel)\n* [RLumCarlo](https://github.com/R-Lum/RLumCarlo)\n* [rxylib](https://github.com/R-Lum/rxylib)\n\n## \u003cspan class=\"glyphicon glyphicon-euro\"\u003e\u003c/span\u003e Funding\n\n* In 2019, the work of Sebastian Kreutzer as maintainer of the package was supported \n  by [LabEx LaScArBx (ANR - n. ANR-10-LABX-52)](https://anr.fr/ProjetIA-10-LABX-0052).\n\n* 01/2020-04/2022: Sebastian Kreutzer as maintainer of the package has\n  received funding from the European Union’s Horizon 2020 research and\n  innovation programme under the Marie Skłodowska-Curie grant agreement\n  [No 844457 (CREDit)](https://cordis.europa.eu/project/id/844457), and\n  could continue maintaining the package.\n\n* since 03/2023: Sebastian Kreutzer as maintainer of the package\n  receives funding from the DFG Heisenberg programme [No\n  505822867](https://gepris.dfg.de/gepris/projekt/505822867).\n\n```{r Outro, echo=FALSE}\ndetach(\"package:RLumBuild\")\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lum%2Frlumbuild","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr-lum%2Frlumbuild","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lum%2Frlumbuild/lists"}