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%"
)
```
# rsf

<!-- badges: start -->
[![R-CMD-check](https://github.com/dchiu911/rsf/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dchiu911/rsf/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/rsf)](https://CRAN.R-project.org/package=rsf)
<!-- badges: end -->

The goal of rsf is to provide an RStudio project template for a Report of Statistical Findings (RSF) using the `bookdown` format. An RSF as a project report, with typical sections Introduction, Method, and Results. Some parts of an RSF often become the main or supplementary materials of a manuscript.

## Installation

You can install the released version of rsf from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("rsf")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("remotes")
remotes::install_github("dchiu911/rsf")
```

## Usage

After installation, you can choose the rsf project template by accessing the RStudio menus: File > New Project > New Directory > Report of Statistical Findings using bookdown.