README.Rmd

---
output: github_document
# add bibliography here
link-citations: true
---

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

# vimclimate: Access climate data time-series from the Vaccine Impact Modelling Consortium

<!-- badges: start -->
[![Project Status: Concept - Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
[![R build status](https://github.com/vimc/vimclimate/workflows/R-CMD-check/badge.svg)](https://github.com/vimc/vimclimate/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/vimc/vimclimate/branch/main/graph/badge.svg)](https://app.codecov.io/gh/vimc/vimclimate?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/vimclimate)](https://CRAN.R-project.org/package=vimclimate)
<!-- badges: end -->

_vimclimate_ is an R package that helps access pre-made climatic variable time-series data for use in modelling.

## Installation

You can install the development version of _vimclimate_ from the [VIMC R-universe](https://vimc.r-universe.dev/) with:

```r
# installation from R-universe
install.packages(
  "vimclimate", 
  repos = c(
    "https://vimc.r-universe.dev", "https://cloud.r-project.org"
  )
)
```

## Quick start

WIP.

## Related projects

- [_clim2parquet_](https://vimc.github.io/clim2parquet/): Used to prepare climate data in Parquet format; this is the data accessed by _vimclimate_.