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%"
)
```
# tidycomm <img src='man/figures/logo.png' align="right" height="138.5" />

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental-1)
[![CRAN status](https://www.r-pkg.org/badges/version/tidycomm)](https://CRAN.R-project.org/package=tidycomm)
[![Codecov test coverage](https://codecov.io/gh/joon-e/tidycomm/branch/master/graph/badge.svg)](https://codecov.io/gh/joon-e/tidycomm?branch=master)
[![R-CMD-check](https://github.com/joon-e/tidycomm/workflows/R-CMD-check/badge.svg)](https://github.com/joon-e/tidycomm/actions)
<!-- badges: end -->

Tidycomm provides convenience functions for common tasks in communication research. All functions follow the style and syntax of the [tidyverse](https://www.tidyverse.org/).

Currently, tidycomm includes functions for various methods of univariate and bivariate data description and analysis, data modification, and intercoder reliability tests. 

## Installation

Install tidycomm from CRAN:

```{r eval = FALSE}
install.packages("tidycomm")
```

Or install the most recent development version of tidycomm with:

```{r eval = FALSE}
remotes::install_github("joon-e/tidycomm")
```

## Usage

```{r}
library(tidycomm)
```

tidycomm functions follow the style and syntax of the [tidyverse](https://www.tidyverse.org/) functions:

- they always assume a `tibble` as their first argument
- they will always return a `tibble` as well, so they can be easily integrated into pipes
- data variables (`tibble` columns) are passed to function calls directly as symbols

```{r}
WoJ %>% # Worlds of Journalism sample data
  describe(autonomy_selection, autonomy_emphasis)
```

Most functions will automatically use all relevant variables in the data if no variables are specified in the function call. For example, to compute descriptive statistics for all numeric variables in the data, just call `describe()` without further arguments:

```{r}
WoJ %>% 
  describe()
```

Likewise, compute intercoder reliability tests for all variables by only specifying the post and coder ID variables:

```{r}
fbposts %>% # Facebook post codings sample data
  test_icr(post_id, coder_id)
```

For detailed examples of all available functions, see the [documentation website](https://joon-e.github.io/tidycomm/) or read the vignettes:

```{r eval = FALSE}
browseVignettes("tidycomm")
```