
# frenchdata

<!-- badges: start -->
[![R-CMD-check](https://github.com/nareal/frenchdata/workflows/R-CMD-check/badge.svg)](https://github.com/nareal/frenchdata/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/frenchdata)](https://CRAN.R-project.org/package=frenchdata)
<!-- badges: end -->

The goal of `frenchdata` is to provide functions to download and read data sets from Prof. Kenneth French finance data library. 

## Installation

Once on CRAN, install the package as usual:
``` r
install.packages("frenchdata")
```

You can install the development version of `frenchdata` directly from GitHub using:
``` r
# install.packages("devtools")
devtools::install_github("nareal/frenchdata")
```

## Usage

To learn more about this package and the functions it provides, please visit the package documentation at [https://nareal.github.io/frenchdata/](https://nareal.github.io/frenchdata/). 

## Getting help

If you encounter a bug, please file an issue with a minimal [reproducible](http://adv-r.had.co.nz/Reproducibility.html) [example](https://reprex.tidyverse.org) on GitHub. 
