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

# roadtrafficdeaths <a href="https://pabsantos.github.io/roadtrafficdeaths/"><img src="man/figures/logo.png" align="right" height="139" alt="roadtrafficdeaths website" /></a>

<!-- badges: start -->

[![R-CMD-check](https://github.com/pabsantos/roadtrafficdeaths/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/pabsantos/roadtrafficdeaths/actions/workflows/R-CMD-check.yaml)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->

The goal of `roadtrafficdeaths` is to provide a dataset of death certificates from road traffic crashes that happened in Brazil, from the Brazilian Ministry of Health.

The dataset is provided in the `data.frame` format. To check each variable, use `?rtdeaths`.

## Installation

You can install the current version of `roadtrafficdeaths` from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("pabsantos/roadtrafficdeaths")
```

## Example

This is a basic example which shows how to use this package:

```{r example}
library(roadtrafficdeaths)

str(rtdeaths)
```

## Credits

The authors of this package would like to thank the authors of [`microdatasus`](https://github.com/rfsaldanha/microdatasus):

> Saldanha, R. D. F., Bastos, R. R., & Barcellos, C. (2019). Microdatasus: pacote para download e pré-processamento de microdados do Departamento de Informática do SUS (DATASUS) (Version 1.0.0) [Computer software]. <https://doi.org/10.1590/0102-311X00032419>

## Citation

If you use this package, please cite as follow:

```{r}
citation("roadtrafficdeaths")
```