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

# hazmat <img src='man/figures/hazmat_logo.png' align="right" height="139"/>

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/hazmat)](https://CRAN.R-project.org/package=hazmat)
[![Travis build status](https://travis-ci.org/actuarialvoodoo/hazmat.svg?branch=master)](https://travis-ci.org/actuarialvoodoo/hazmat)
[![Codecov test coverage](https://codecov.io/gh/actuarialvoodoo/hazmat/branch/master/graph/badge.svg)](https://codecov.io/gh/actuarialvoodoo/hazmat?branch=master)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/actuarialvoodoo/hazmat?branch=master&svg=true)](https://ci.appveyor.com/project/actuarialvoodoo/hazmat)
<!-- badges: end -->

The goal of hazmat is to provide a simple way for educators, and other folks that
need to run a lot of other people's code, to have some confidence that there
aren't any unexpected *scary* R snippets.

This package was motivated by this exchange on twitter.
<a href='https://twitter.com/ryebreadnyc/status/1186665880098430977'><img src = 'man/figures/convo_1.png' ></a>

<a href='https://twitter.com/ryebreadnyc/status/1186665880098430977'><img src = 'man/figures/convo_2.png' ></a>



## Installation


``` r
# install.packages("devtools")
devtools::install_github("actuarialvoodoo/hazmat")
```

## Usage

Currently, hazmat supports searching individual files or all R/Rmd files in a
folder for the following hazardous code snippets:

 - setwd
 - system
 - rm(ls = ls()).

```{r example, eval=TRUE, echo=TRUE}
library(hazmat)
## basic example code

screen_folder("examples")
```

---
Please note that the 'hazmat' project is released with a
[Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.