README.md

layeredBB

Code to implement methods for simulating Brownian motion, Brownian bridges and layered Brownian bridge skeletons. Please see function documentation for example usage.

Installation

Simply run: devtools::install_github('rchan26/layeredBB').

Note that there are vignettes available, but by default devtools::install_github() does not build them since they are time consuming. To force building, use devtools::install_github('rchan26/layeredBB', build_vignettes = TRUE).

Using with parallel

Here is an example to use in a cluster using parallel:

library(layeredBB)
library(parallel)

# creating parallel cluster with maximum number of cores available
n_cores <- parallel::detectCores()
cl <- parallel::makeCluster(n_cores)

# export functions from layeredBB into the cluster environment
parallel::clusterExport(cl, varlist = ls("package:layeredBB"))

##### do some stuff in cluster using layeredBB functions ######

# stop cluster
parallel::stopCluster(cl)

Development workflow

If any code has been modified, call:

Rcpp::compileAttributes()
pkgbuild::compile_dll()
devtools::document()
devtools::install()

To build vignettes use:

devtools::build_vignettes()

Or, you can use

devtools::build()

to create a package bundle with the vignettes included.

Then can test the package by calling: devtools::test()

Resources

License

Shield: CC BY 4.0

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0



rchan26/layeredBB documentation built on March 25, 2022, 3:44 a.m.