README.md

In chrismainey/brilliant:

brilliant

This is a demo package as part of a package building tutorial. Slides avaialbel here: https://chrismainey.github.io/PackageBuildSeminar/package_building_presentation.html

Installation

You can install the development version of this package from GitHub, if you have devtools installed, using:

# install.packages("devtools")
devtools::install_github("chrismainey/brilliant")

Example

This is a demo package for UCL IHI code club. We built a package with a single function for calculating a percentage. We used roxygen2 to build the NAMESPACE, document the functions, building the help files. We also added a basic unit test using the testthat package, and an AGPL-3 licence using functions from the usethis package. usethis is a great tool for helping with all sorts of development tasks.

library(brilliant)

percentage(20,50)
#> [1] 40

chrismainey/brilliant documentation built on Feb. 3, 2021, 4:37 p.m.