---
title: "SCoRES: a vignette"
author: "Zhuoran (Angela) Yu"
date: "`r Sys.Date()`"
output: 
  rmarkdown::html_vignette:
    toc: true
    toc_depth: 2
    number_sections: true
vignette: >
  %\VignetteEncoding{UTF-8}
  %\VignetteIndexEntry{SCoRES: a vignette}
  %\VignetteEngine{knitr::rmarkdown}
editor_options: 
  chunk_output_type: console
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

The `SCoRES` package is for estimating the simultaneous confidence regions for inverse regions.

This vignette outlines the general functionality of the package.
The package can handle discrete data, continuous data, functional data, and geographic data. It also provides users with functions to estimate the simultaneous confidence bands for both the mean outcome and coefficients from linear regression, logistic regression, functional regression and spatial generalized least squares regression.
Details on how to estimate SCRs of inverse regions for linear and logistic regression with the `SCoRES` package can be found in the vignette `"Linear_Model_Example"`. For instructions on functional data, see vignette `"Functional_Data_Example"`. For geographic data, see vignette `"Geographic_Data_Example"`. For detailed explanation of the methods used for estimating SCI and inverse set SCI, see vignette `"Methods"`.

```{r setup}
library(SCoRES)
```
