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

# c4meta

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->

The c4meta package provides metadata about the [C4](https://github.com/allenai/allennlp/discussions/5056) dataset (Google's [Colossal Clean Crawled Corpus](https://www.tensorflow.org/datasets/catalog/c4))

## Installation

You can install the released version of c4meta from [CRAN](https://CRAN.R-project.org) with:

``` r
# Not yet.
#install.packages("c4meta")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("macmillancontentscience/c4meta")
```

## Example

Coming soon.

## Code of Conduct

Please note that the c4meta project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

## Disclaimer

This is not an officially supported Macmillan Learning product.

## Contact information

Questions or comments should be directed to Jonathan Bratt (jonathan.bratt@macmillan.com) and Jon Harmon (jonthegeek@gmail.com).

## License

The C4 dataset is released under the terms of [ODC-BY](https://opendatacommons.org/licenses/by/1-0/). By using this package, you are also bound by the [Common Crawl terms of use](https://commoncrawl.org/terms-of-use/) in respect of the content contained in the dataset.