diff --git a/README.Rmd b/README.Rmd index d7447c4..5bcae90 100644 --- a/README.Rmd +++ b/README.Rmd @@ -4,7 +4,7 @@ output: github_document -```{r, include = FALSE} +```{r, include=FALSE} knitr::opts_chunk$set( collapse = TRUE, comment = "#>", @@ -13,22 +13,33 @@ knitr::opts_chunk$set( ) ``` - # hubEvals hubEvals website + [![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/hubEvals)](https://CRAN.R-project.org/package=hubEvals) [![R-CMD-check](https://github.com/hubverse-org/hubEvals/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hubverse-org/hubEvals/actions/workflows/R-CMD-check.yaml) + The goal of hubEvals is to provide tools for evaluating infectious disease model outputs. This package is part of the [Hubverse](https://hubverse.org) project, which aims to provide a suite of tools for infectious disease modeling hubs. ## Installation -You can install the development version of hubEvals from [GitHub](https://github.com/) with: +### Latest + +You can install the [latest version of hubEvals from the R-universe](https://hubverse-org.r-universe.dev/hubAdmin): + +```r +install.packages("hubEvals", repos = c("https://hubverse-org.r-universe.dev", "https://cloud.r-project.org")) +``` -``` r +### Development + +If you want to test out new features that have not yet been released, you can install the development version of hubEvals from [GitHub](https://github.com/) with: + +```r # install.packages("remotes") remotes::install_github("hubverse-org/hubEvals") ``` @@ -48,8 +59,9 @@ library(hubEvals) Please note that the hubEvals package is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms. - ## Contributing Interested in contributing back to the open-source Hubverse project? Learn more about how to [get involved in the Hubverse Community](https://hubverse.io/en/latest/overview/contribute.html) or [how to contribute to the hubEvals package](.github/CONTRIBUTING.md). + +