README.qmd

---
format: gfm
default-image-extension: ""
---

<!-- README.md is rendered from README.qmd. Edit README.qmd and render to update README.md -->

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

# {historydata}

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

## Overview

These sample data sets are intended for historians learning R. They include population, institutional, religious, military, and prosopographical data suitable for mapping, quantitative analysis, and network analysis.

## Installation

To install the latest [r-universe](https://ropensci.r-universe.dev/historydata) build:

```{R install-r-universe, echo=TRUE, eval=FALSE}
install.packages('historydata', repos = c('https://ropensci.r-universe.dev'))
```

To install the package from [CRAN](https://cran.r-project.org/package=historydata):

```{R install-cran, echo=TRUE, eval=FALSE}
install.packages("historydata")
```

You can install the development version from [GitHub](https://github.com/ropensci/historydata) with {devtools}:

```{R install-github, echo=TRUE, eval=FALSE}
# install.packages("devtools")
devtools::install_github("ropensci/historydata")
```

## Use

See the [package index reference](https://docs.ropensci.org/historydata/reference/index.html) for all the datasets in the package and their documentation. You can also use R's builtin help:

```{R help, echo=TRUE, eval=FALSE, output=FALSE}
help(package = historydata)
```

To load a dataset directly into your environment:

```{R load, echo=TRUE, eval=TRUE, output=TRUE}
data(catholic_dioceses)
head(catholic_dioceses)
```

## License

This project is released under the MIT License. See [LICENSE.md](./LICENSE.md) for details.

---
[![rOpenSci footer](https://ropensci.org//public_images/github_footer.png)](https://ropensci.org/)