Skip to content

Commit

Permalink
render README
Browse files Browse the repository at this point in the history
  • Loading branch information
zkamvar committed Sep 20, 2024
1 parent a7da337 commit 95eb59b
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@

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

# hubEvals <a href="https://Infectious-Disease-Modeling-Hubs.github.io/hubEvals/"><img src="man/figures/logo.svg" align="right" height="131" alt="hubEvals website" /></a>
# hubEvals <a href="https://hubverse-org.github.io/hubEvals/"><img src="man/figures/logo.svg" align="right" height="131" alt="hubEvals website" /></a>

<!-- 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/hubEvals)](https://CRAN.R-project.org/package=hubEvals)
[![R-CMD-check](https://github.com/Infectious-Disease-Modeling-Hubs/hubEvals/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Infectious-Disease-Modeling-Hubs/hubEvals/actions/workflows/R-CMD-check.yaml)
[![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)

<!-- badges: end -->

The goal of hubEvals is to provide tools for evaluating infectious
Expand All @@ -19,12 +20,24 @@ of tools for infectious disease modeling hubs.

## Installation

You can install the development version of hubEvals from
### 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"))
```

### 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("Infectious-Disease-Modeling-Hubs/hubEvals")
remotes::install_github("hubverse-org/hubEvals")
```

## Example
Expand All @@ -48,5 +61,5 @@ project, you agree to abide by its terms.

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).
Community](https://hubverse.io/en/latest/overview/contribute.html) or
[how to contribute to the hubEvals package](.github/CONTRIBUTING.md).

0 comments on commit 95eb59b

Please sign in to comment.