Skip to content

R-Lum/RLumBuild

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
R
 
 
 
 
man
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

RLumBuild

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

lifecycle GitHub release GitHub Release Date R-CMD-check

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 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

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

RLumBuild::build_package()

In conjunction with RStudio 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.

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

as_cran

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

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 for more details.

Projects using RLumBuild

Funding

  • In 2019, the work of Sebastian Kreutzer as maintainer of the package was supported by LabEx LaScArBxSK (ANR - n. ANR-10-LABX-52).

  • From 2020, Sebastian Kreutzer as maintainer of the package received funding from the European Union’s Horizon 2020 research and innovation programme under the Marie Skłodowska-Curie grant agreement No 844457.