README.md

In CGMossa/rbatteries: Help write R with all the batteries included

rbatteries

The goal of rbatteries is to illustrate a point. About workflows within science using modern R idioms and packages.

Installation

You cannot install the released version of rbatteries from CRAN with:

install.packages("rbatteries")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("CGMossa/rbatteries")

Currently, one needs access to this repository inorder to make the install_github-call work as intended.

Overview

This package was created using usethis. The first example developed is the rbatteries::resample. Alongside this functionality, there are also tests to ensure that this resample method works as intended.

The help-file to rbatteries::resample should be very clear and close to the source code.

A vignette is there to document behaviour, decisions and assumptions, that is then made into unit-tests.

browseVignettes("rbatteries")

to see these [1]. Note however that you need to enforce the building of vignettes, when installing an R-package from, say, GitHub. Thus,

devtools::install_github("CGMossa/rbatteries", build_vignettes = TRUE)

is needed here.

Note that when such a package gets sent to CRAN, or drat-powered repositories, doesn’t need to build the vignettes on their own, but for now, this is necessary.

1. Currently, one on resample. Maybe more will follow.

CGMossa/rbatteries documentation built on Oct. 30, 2019, 5:29 a.m.