README.md

mndredge

Travis-CI Build Status Coverage Status

This repo contains data dredging routines.

Documentation

Documentation can be found here

Installation

Official, stable release

None yet.

Latest development build

To install the latest development snapshot, type following commands into the R console

# install.packages('devtools')
devtools::install_github("markanewman/mndredge")
library(mndredge)

Rebuild from scratch

  1. Clone the repo from GitHub
    • I suggest to C:\repos\mndredge
  2. Open up R Studio
  3. Run the below code to recompile everything
# install libraries (if needed)
# install.packages('devtools')
# install.packages('roxygen2')
# install.packages('pkgdown')
# devtools::install_github("markanewman/mnmacros")

# set working directory and clean files that will be regenerated
setwd("C:/repos/mndredge")
unlink(c("./docs/*", "./man/*", "./NAMESPACE"), recursive = T)

# regenerate NAMESPACE
devtools::document()

# run the tests
devtools::test()

# add in github pages
pkgdown::build_site()

# full check before the package is CRAN ready
devtools::check()


markanewman/mndredge documentation built on May 9, 2019, 5:52 a.m.