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

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

<!-- badges: start -->
[![R-CMD-check](https://github.com/ONSV/onsvtables/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ONSV/onsvtables/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The `onsvtables` package provides a function for customizing `gt` tables with the [National Road Safety Observatory (ONSV)](https://www.onsv.org.br/) style.

## Installation

You can install the latest release of `onsvtables` from CRAN with:

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

Or the development version:

``` r
devtools::install_github("jotasaraiva/onsvtables")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(onsvtables)

df <- data.frame(
  var1 = c("lorem", "ipsum", "dolor"),
  var2 = c(1, 2, 3)
)

tbl_onsv <-
  df |>
  gt::gt() |>
  tab_onsv()
```

### Citation

This package can be cited as follows:

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