README.Rmd

---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file. -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

# pixarfilms <img src="man/figures/logo.png" align="right" alt="" width="120" />

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/pixarfilms)](https://CRAN.R-project.org/package=pixarfilms)
[![R build status](https://github.com/erictleung/pixarfilms/workflows/R-CMD-check/badge.svg)](https://github.com/erictleung/pixarfilms/actions)
[![downloads](https://cranlogs.r-pkg.org/badges/pixarfilms)](https://cran.r-project.org/package=pixarfilms)
[![total\_downloads](https://cranlogs.r-pkg.org/badges/grand-total/pixarfilms)](https://cran.r-project.org/package=pixarfilms)
[![frictionless](https://github.com/erictleung/pixarfilms/actions/workflows/frictionless.yml/badge.svg)](https://github.com/erictleung/pixarfilms/actions/workflows/frictionless.yml)
[![License CC0](https://img.shields.io/cran/l/pixarfilms)](https://img.shields.io/cran/l/pixarfilms)
[![Project Type Toy Badge](https://img.shields.io/badge/project%20type-toy-blue)](https://project-types.github.io/#toy)
<!-- badges: end -->

> R data package to explore Pixar films, the people, and reception data

This package contains six data sets provided mostly in part by
[Wikipedia](https://en.wikipedia.org/wiki/List_of_Pixar_films).

- `pixar_films` - released and upcoming films
- `pixar_people` - main people involved in creating films
- `genres` - movie genres for each film
- `box_office` - box office reception and budget information
- `public_response` - critical and public response
- `academy` - academy awards and nominations

## Installation

Install `pixarfilms` from CRAN:

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

Or you can install the development version of `pixarfilms` from GitHub with:

```{r, eval = FALSE}
remotes::install_github("erictleung/pixarfilms")
```

## Example

```{r}
library(pixarfilms)
pixar_films
```

## Documentation

You can find information about the data sets and more
[here](https://erictleung.com/pixarfilms/). The official CRAN release page can
be found [here](https://cran.r-project.org/package=pixarfilms). And last, a
list of vignettes showcasing some analyses you can do with this package can be
found [here](https://erictleung.com/pixarfilms/articles/).


## Data

This data here within is not constrained to exploring just within R.

Here are direct links to each data set.

```
https://raw.githubusercontent.com/erictleung/pixarfilms/main/data-raw/academy.csv
https://raw.githubusercontent.com/erictleung/pixarfilms/main/data-raw/box_office.csv
https://raw.githubusercontent.com/erictleung/pixarfilms/main/data-raw/genres.csv
https://raw.githubusercontent.com/erictleung/pixarfilms/main/data-raw/pixar_films.csv
https://raw.githubusercontent.com/erictleung/pixarfilms/main/data-raw/pixar_people.csv
https://raw.githubusercontent.com/erictleung/pixarfilms/main/data-raw/public_response.csv
```

There's also a `datapackage.json` file (located at `/data-raw/datapackage.json`)
to be a computer-readable data dictionary describing the contents of each data
file as described in
[the data package specifications](https://specs.frictionlessdata.io/data-package/).


## Feedback

If you have any feedback or suggestions on other data that can be added, please
file an issue [here](https://github.com/erictleung/pixarfilms/issues).


## Code of Conduct

Please note that the {pixarfilms} 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.

## Acknowledgments

- [Wikipedia](https://www.wikipedia.org)
- [OMDb API](https://www.omdbapi.com/)
- [babynames](https://github.com/hadley/babynames) (for inspiration)