02_create_r_package_steps.R

In Wei-Lim/lighting: Lighting Tools

# LAB 44: CREATE AN R PACKAGE STEPS ----

# RESOURCES:
# - R PACKAGES: https://r-pkgs.org/index.html

# LIBRARIES FOR SETUP ----
library(usethis)
library(available)
library(devtools)
library(pkgdown)
library(tidyverse)

# 1.0 CHECK IF PACKAGE IS AVAILABLE ----
# - DO THIS IF GOING ON CRAN (PUBLIC)
# - NOT REQUIRED FOR PRIVATE
available::available("lighting")

# * Create package ----
usethis::create_package("../lighting")

# 2.0 SETTING THE PACKAGE UP ----

# * Setup git
usethis::use_git()

# * Code Repository ----
# - Requires setup of GH Auth Token: browse_github_token()
# - Refresh your R Session once you update your '.Renviron'
usethis::use_github(private = FALSE)

# * Basic Package Setup ----
usethis::use_roxygen_md()
usethis::use_ccby_license()
#usethis::use_mit_license(name = "BUSINESS SCIENCE")
usethis::use_readme_rmd()
usethis::use_news_md()
usethis::use_vignette("getting-started", title = "Getting Started with lighting")

# * Development ----
usethis::use_pipe()
usethis::use_tidy_eval()
usethis::use_tibble()
usethis::use_data_table()

# * Create a Function ----
usethis::use_r("extract_lum_intensity_ldt")

# * Sample Data ----
# - For testing/documentation purposes
telco_data <- readr::read_rds("../lab_44_package_setup/data/telco_data.rds")
usethis::use_data(telco_data)

# * Tests ----
usethis::use_testthat()
usethis::use_test("light_distribution")

# * Pkgdown Website ----
usethis::use_pkgdown()
pkgdown::build_site()

# * Continuous Integration ----
# usethis::use_github_action()
# usethis::use_travis()
# usethis::use_jenkins()

# 3.0 SAMPLE DESCRIPTION FILE ----

# Package: hr.churn.test
# Title: HR Churn Workflow Tools
# Version: 0.0.0.9000
# Authors@R: c(
#     person("Matt", "Dancho", email = "info@business-science.io", role = c("aut", "cre")),
#     person("Business Science", role = "cph"))
# Description:
#     Human Resources churn workflow analysis tools and PowerPoint Report Automation.
# License: MIT + file LICENSE
# Imports:
#     tidyquant,
#     dplyr,
#     ggplot2,
#     purrr,
#     officer,
#     flextable,
#     cli,
#     magrittr,
#     rlang (>= 0.1.2),
#     stringr,
#     forcats,
#     scales,
#     tidyselect
# Suggests:
#     tidyverse,
#     testthat,
#     knitr,
#     rmarkdown,
#     roxygen2
# VignetteBuilder: knitr
# Encoding: UTF-8
# LazyData: true
# Roxygen: list(markdown = TRUE)
# RoxygenNote: 7.1.1
# Depends:
#     R (>= 2.10)
# URL: https://github.com/mdancho84/hr.churn.test
# BugReports: https://github.com/mdancho84/hr.churn.test/issues