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

# nefin

<!-- badges: start -->

[![R-CMD-check](https://github.com/Reckziegel/nefin/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Reckziegel/nefin/actions/workflows/R-CMD-check.yaml)

<!-- badges: end -->

The goal of `nefin` is to facilitate the access to the datasets computed by NEFIN: <http://nefin.com.br/>.

The package is reviewed monthly in order to keep the API working properly.

Any doubts or suggestions, please, open an issue.

This file was last updated at: `r Sys.time()`.

# Installation

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

``` r
# install.packages("devtools")
devtools::install_github("Reckziegel/nefin")
```

## Example

```{r example}
library(nefin)

# Get the Brazilian Risk Factors
risk_factors()

# Get the Dividend Yield for the Market
dividend_yield()

# Cost of Equity for Different Horizons and Sectors
cost_of_equity()

# Fama-French Factor Portfolios
portfolios_sorted_by_book_to_market()
```