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

# wikirest

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

The goal of wikirest is to get data from the Wikimedia REST API.

## Installation

You can install the development version of wikirest from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("clessn/wikirest")
```

## Example

```{r example}
library("wikirest")

get_most_viewed_per_country(
  country = "CA",
  access = "all-access",
  date = "2022-01-01",
  tidy = TRUE
) |>
  utils::head()
```

## Usage

For API documentation, terms of service and licensing information, see [wikimedia.org/api/rest_v1/](https://wikimedia.org/api/rest_v1/).