ihmeuw-demographics / hierarchyUtils

Demographics Related Utility Functions
https://ihmeuw-demographics.github.io/hierarchyUtils/
BSD 3-Clause "New" or "Revised" License
8 stars 3 forks source link

Set up base R package #1

Closed chacalle closed 4 years ago

chacalle commented 4 years ago

Create a basic skeleton for our new R packages

# create base R package
usethis::create_package(path = PATH)

## update .gitignore
# add "R", "Windows", "MacOS" .gitignore template from gitignore.io

## set up testing framework
usethis::use_testthat()
# create empty placeholder file `/tests/testhat/test_placeholder.R`

## use roxygen but with markdown functionality
usethis::use_roxygen_md()

# set up to create pkgdown site
usethis::use_pkgdown()

## update license
usethis::use_gpl3_license(name = "Institute for Health Metrics and Evaluation")

# create template vignette
usethis::use_vignette(name = "placeholder")

## spellcheck our documentation
usethis::use_spell_check()

## almost all of our packages will use data.table internally
usethis::use_data_table()

## set up to use Travis CI
usethis::use_travis()

## set up to produce test coverage reports
usethis::use_coverage()