mediacloud/README.Rmd

---
output: rmarkdown::github_document
editor_options: 
  chunk_output_type: inline
---
```{r pkg-knitr-opts, include=FALSE}
knitr::opts_chunk$set(
  collapse = TRUE, fig.retina = 2, message = FALSE, warning = FALSE
)
options(width=120)
```

[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/mediacloud.svg?branch=master)](https://travis-ci.org/hrbrmstr/mediacloud) 
[![Coverage Status](https://codecov.io/gh/hrbrmstr/mediacloud/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/mediacloud)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/mediacloud)](https://cran.r-project.org/package=mediacloud)

# mediacloud [WIP]

Tools to Query the 'Media Cloud' 'API'

## Description

'Media Cloud' (<https://mediacloud.org/>) is an open source platform for studying media ecosystems. By tracking millions of stories published online, their suite of tools allows researchers to track how stories and ideas spread through media and help researchers answer complex quantitative and qualitative questions about the content of online media. Methods are provided to query the 'Media Cloud' 'API'.
    
## What's Inside The Tin

The following functions are implemented:

```{r ingredients, results='asis', echo=FALSE, cache=FALSE}
hrbrpkghelpr::describe_ingredients()
```

## Installation

```{r install-ex, results='asis', echo = FALSE}
hrbrpkghelpr::install_block()
```

## Usage

```{r lib-ex}
library(mediacloud)

# current version
packageVersion("mediacloud")

```

## mediacloud Metrics

```{r cloc, echo=FALSE}
cloc::cloc_pkg_md()
```

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). 
By participating in this project you agree to abide by its terms.