README.md

In txqtiffany/STAT302package: Package Building Demonstration

STAT302package

The goal of STAT302package is a demonstration on my learning of developing a well-documented, well-tested, and well-explained R package from the course of STAT 302.

Installation

You can install the STAT302package using the following line:

devtools::install_github("txqtiffany/STAT302package", build_vignette = TRUE, build_opts = c())
library(STAT302package)

Use

The vignette demonstrates example usage of all main functions. You can see the vignette by using the following code:

library(STAT302package)
# Use this to view the vignette in the corncob HTML help
help(package = "STAT302package", help_type = "html")
# Use this to view the vignette as an isolated HTML file
utils::browseVignettes(package = "STAT302package")

txqtiffany/STAT302package documentation built on Dec. 23, 2021, 1:03 p.m.