README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# Stat406

<!-- badges: start -->
[![R-CMD-check](https://github.com/UBC-STAT/stat-406-rpackage/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/UBC-STAT/stat-406-rpackage/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of Stat406 is to allow students enrolled in the course to install
all necessary packages at once. It also provides data and documentation
for all Homework Assignments and Labs for easy loading, along with a few
helper functions to verify system setup.

## Installation

You can install the development version of Stat406 from [GitHub](https://github.com/) with:

```{r, echo=TRUE, eval=FALSE}
# install.packages("remotes")
remotes::install_github("UBC-STAT/stat-406-rpackage", dependencies = TRUE)
```

## Start up

Once you have installed the package, you should run
```{r, echo=TRUE, eval=FALSE}
test_latex_installation()
```
This will attempt to compile a small LaTeX document (in preparation for
homework and labs). If it works, you'll see something like:
```{r, echo=FALSE}
cli::cli_process_start("Attempting to compile a LaTeX document.")
cli::cli_process_done()
cli::cli_alert_success("LaTeX is available. You're good to go.")
```
If it fails, you'll see:
```{r, echo=FALSE}
cli::cli_process_failed()
cli::cli_alert_danger(
        "LaTeX does not appear to be installed. But, it may have installed automatically"
)
cli::cli_h1("Next steps.")
cli::cli_alert_info("Try running this function again.")
cli::cli_alert_info("If you still see this message, run {.fn tinytex::install_tinytex}.")
```
Ideally, LaTeX automatically installed itself. Try the function again. You
may need to restart `R`. You may need to restart your machine. 
If it still doesn't work, follow the instructions.

If you still get errors, then contact the teaching team on Slack or in 
Office Hours.