---

output: github_document

---

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

# rOpenSci Unconf 18 Project : defender

<img src="man/figures/supergb.png" style="width: 50%; height: 50%"/>

```{r, echo = FALSE}

knitr::opts_chunk$set(

collapse = TRUE,

comment = "#>",

fig.path = "README-"

)

```

# defender <img src="man/figures/logo.png" align="right"/>

<!-- badges: start -->

[](https://travis-ci.org/ropenscilabs/defender)

[](https://codecov.io/github/ropenscilabs/defender?branch=master)

[](https://www.tidyverse.org/lifecycle/)

<!-- badges: end -->

The goal of defender is to do static code analysis on other R packages to check for potential security risks and best practices. It provides checks on multiple levels:

1. [x] static code analysis without installing the package

2. [ ] more thorough but potentially dangerous checks with installation / in Docker container

The checks do not tell you whether something is harmful but rather they flag code that you should double-check before running / loading the package.

## Installation

You can install defender from github with:

```{r gh-installation, eval = FALSE}

# install.packages("devtools")

devtools::install_github("ropenscilabs/defender")

```

## Example

### System calls in R scripts

You can check for system calls in any directory locally available:

```{r system-calls-example, eval = FALSE}

defender::summarize_system_calls("../testevil")

```

You can also include additional elements to flag as dangerous:

```{r system-calls-example-2, eval = FALSE}

sc <- defender::system_calls("poll")

defender::summarize_system_calls("../testevil", calls_to_flag = sc)

```

### System-related imports in NAMESPACE

You can check the NAMESPACE file in a package for dangerous imports:

```{r namespace-example, eval = FALSE}

defender::check_namespace("../testevil")

```

You can also include additional elements to flag as dangerous:

```{r namespace-example-2, eval = FALSE}

di <- defender::dangerous_imports("processx::poll")

defender::check_namespace("../testevil", imports_to_flag = di)

```

## Collaborators

- Ildi Czeller @czeildi

- Karthik Ram @karthik

- Bob Rudis @hrbrmstr

- Kara Woo @karawoo