Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/r-lum/rlumbuild

RLum Universe Package Building
https://github.com/r-lum/rlumbuild

Last synced: about 2 hours ago
JSON representation

RLum Universe Package Building

Awesome Lists containing this project

README 

        
---

output: github_document

header-includes:

   - \usepackage{amsmath}

   - \usepackage{amssymb}

---



```{r, echo = FALSE, message=FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-"

)

library(RLumBuild)

```



# RLumBuild 



**Build packages from the RLum-universe. A collection of tools and scripts to unify the building of packages.**



[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)

![GitHub release](https://img.shields.io/github/release/R-Lum/RLumBuild.svg)

![GitHub Release Date](https://img.shields.io/github/release-date/R-Lum/RLumBuild.svg)

[![R-CMD-check](https://github.com/R-Lum/RLumBuild/workflows/GitHub Actions CI/badge.svg)](https://github.com/R-Lum/RLumBuild/actions)



Over 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://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. 



The 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

further custom modules (functions in the package 'RLumBuild'), to, e.g., add a new section 'How to cite' to 

add function related citation information. 



*Note: 'RLumBuild' is no CRAN package and it will not be submitted to CRAN, since the number of potential 

users is very small. However, as for all other packages we develop, we apply the same quality standards.* 



## Installation



```{r, eval=FALSE}

if(!require("devtools"))

  install.packages("devtools")

devtools::install_github("R-Lum/RLumBuild@master")

```



## Examples and how to use the package



A packages builds by simply calling 



```{r, eval=FALSE}

RLumBuild::build_package()

```



In conjunction with [RStudio](https://www.rstudio.com/products/rstudio/download/) a 

short bash script allowing a full integration is more useful. 



```{}

#!/bin/bash



R -q -e "RLumBuild::build_package()"

```



This script is stored in the package directory and connected with *RStudio* via 

*Project Options >> Build Tools >> Project Build Tools >> [Custom]*



The function itself does not require arguments to run, however, it has arguments that 

can be used to control the build process:  



#### `  write_Rbuildignore`



If set to `TRUE` (the default) every `.Ruildignore` is overwritten by a template shipped

with the package. Please note that this file is highly customised to serve package building 

in the RLum-universe.



#### `exclude`



The package is mainly organised in modules (basically single, documented package functions

staring with `modul_`). Every module serves a different process and is not essential 

to build the package but provide some additional features (e.g., automated version numbering). 

To prevent that a particular module is called, it can be excluded using the argument `exclude`, 

e.g, the subsequent call prevents the `NEWS.md` file from being created. 



```{r, eval = FALSE}

RLumBuild::build_package(exclude = c("module_knit_NEWS"))

```



#### `as_cran`



This argument allows to enable/disable the `--as-cran` check.



```{r, eval = FALSE}

RLumBuild::build_package(as_cran = TRUE)

```



## License



This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

any later version.



 This program is distributed in the hope that it will be useful,

 but WITHOUT ANY WARRANTY; without even the implied warranty of

 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 [GNU General Public License](https://github.com/R-Lum/RLumBuild/blob/master/LICENSE) for more details.



## Projects using RLumBuild



* [BayLum](https://github.com/R-Lum/BayLum)

* [Luminescence](https://github.com/R-Lum/Luminescence)

* [RCarb](https://github.com/R-Lum/RCarb)

* [RLumModel](https://github.com/R-Lum/RLumModel)

* [RLumCarlo](https://github.com/R-Lum/RLumCarlo)

* [rxylib](https://github.com/R-Lum/rxylib)



##  Funding



* In 2019, the work of Sebastian Kreutzer as maintainer of the package was supported 

  by [LabEx LaScArBx (ANR - n. ANR-10-LABX-52)](https://lascarbx.labex.u-bordeaux.fr/en/).



* 01/2020-04/2022: Sebastian Kreutzer as maintainer of the package has

  received funding from the European Union’s Horizon 2020 research and

  innovation programme under the Marie Skłodowska-Curie grant agreement

  [No 844457 (CREDit)](https://cordis.europa.eu/project/id/844457), and

  could continue maintaining the package.



* since 03/2023: Sebastian Kreutzer as maintainer of the package

  receives funding from the DFG Heisenberg programme [No

  505822867](https://gepris.dfg.de/gepris/projekt/505822867).



```{r Outro, echo=FALSE}

detach("package:RLumBuild")

```