README.Rmd

---
output: github_document
---

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

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# RSLP
> Removedor de Sufixos da Língua Portuguesa

[![R build status](https://github.com/dfalbel/rslp/workflows/R-CMD-check/badge.svg)](https://github.com/dfalbel/rslp/actions)
[![Travis-CI Build Status](https://travis-ci.org/dfalbel/rslp.svg?branch=master)](https://travis-ci.org/dfalbel/rslp)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/dfalbel/rslp?branch=master&svg=true)](https://ci.appveyor.com/project/dfalbel/rslp)
[![codecov](https://codecov.io/gh/dfalbel/rslp/branch/master/graph/badge.svg)](https://codecov.io/gh/dfalbel/rslp)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rslp)](https://cran.r-project.org/package=rslp)
[![](http://cranlogs.r-pkg.org/badges/rslp)](https://CRAN.R-project.org/package=rslp)

This package uses the algorithm *Stemming Algorithm for the Portuguese Language* described in [this article](http://doi.ieeecomputersociety.org/10.1109/SPIRE.2001.10024) by Viviane Moreira Orengo and Christian Huyck.

The idea of the stemmer is very well explained by the following schema.

![Schema](https://raw.githubusercontent.com/dfalbel/rslp/master/README-schema.PNG)

## Installing

To install the package you can use the following:

```{r, eval=FALSE}
devtools::install_github("dfalbel/rslp")
```

## Using

The only important function of the package is the `rslp` function.
You can call it on a vector of characters like this:

```{r}
library(rslp)
words <- c("balões", "aviões", "avião", "gostou", "gosto", "gostaram")
rslp(words)
```

It works with vector of texts too, using the `rslp_doc` function.

```{r}
docs <- c(
  "coma frutas pois elas fazem bem para a saúde.",
  "não coma doces, eles fazem mal para os dentes."
  )
rslp_doc(docs)
```