---
title: "1 - Installing swaRm"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{1 - Installing swaRm}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

__This page describes the installation process of [`swaRm`](https://github.com/swarm-lab/swaRm).__ 

`swaRm` has not been released on [CRAN](https://cran.r-project.org/) yet, but it 
can be easily installed from its [GitHub repository](https://github.com/swarm-lab/swaRm)
with the following steps. 

---

+ [1.1 - Before installing ](#before-installing)
+ [1.2 - Installing swaRm](#installing-swarm)
+ [1.3 - Loading swaRm](#loading-swarm)
  
---

## 1.1 - Before installing

Before installing `swaRm`, you will need to install the latest version of the [`devtools`](https://CRAN.R-project.org/package=devtools) package. You can install [`devtools`](https://CRAN.R-project.org/package=devtools)  from 
[`CRAN`](https://cran.r-project.org) as follows: 

```{r, message=FALSE, eval=FALSE}
if (!require(devtools))
  install.packages("devtools")
```

---

## 1.2 - Installing swaRm

You can install `swaRm` as follows:

```{r, message=FALSE, eval=FALSE}
devtools::install_github("swarm-lab/swaRm")
```

---

## 1.3 - Loading swaRm

```{r, message=FALSE, eval=FALSE}
library(swaRm)
```