README.md

In markanewman/apaformat: apa format

apaformat

The aim of apaformat is to provide a collection of convenient functions for APA Formatting useful when writing papers in bookdown

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

if (!require('devtools')) install.packages('devtools', quiet=TRUE)
devtools::install_github("markanewman/apaformat", quiet = T)
library(apaformat)

Rebuild from scratch

1. Clone the repo from GitHub
   • I suggest to C:\repos\apaformat
2. Open up R Studio
3. Run the below code to recompile everything

# load libraries
if (!require('devtools')) install.packages('devtools', quiet=TRUE)
if (!require('roxygen2')) install.packages('roxygen2', quiet=TRUE)
if (!require('pkgdown')) install.packages('pkgdown', quiet=TRUE)

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

# recompile the test data and run the tests
testthat::source_dir('./data-raw')
devtools::test()

# add in documentation and github pages
devtools::document()
pkgdown::build_site()

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

markanewman/apaformat documentation built on May 10, 2019, 1:19 a.m.