From fc3aa6e71769ca60c846d5e8693fe3699715120d Mon Sep 17 00:00:00 2001 From: "Zhian N. Kamvar (UMass)" Date: Fri, 20 Sep 2024 09:26:47 -0700 Subject: [PATCH] update installation instructions --- README.Rmd | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.Rmd b/README.Rmd index fdd3d4e9..4cc0e68c 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 = "#>", @@ -16,37 +16,49 @@ knitr::opts_chunk$set( # hubValidations hubValidations website + [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![Codecov test coverage](https://codecov.io/gh/hubverse-org/hubValidations/branch/main/graph/badge.svg)](https://app.codecov.io/gh/hubverse-org/hubValidations?branch=main) [![R-CMD-check](https://github.com/hubverse-org/hubValidations/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hubverse-org/hubValidations/actions/workflows/R-CMD-check.yaml) + The goal of hubValidations is to provide a testing framework for performing hubverse hub validations. ## Installation -You can install the development version of hubValidations like so: +### Latest + +You can install the [latest version of hubValidations from the R-universe](https://hubverse-org.r-universe.dev/hubAdmin): + +```r +install.packages("hubValidations", 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 hubValidations from [GitHub](https://github.com/) with: -``` r +```r remotes::install_github("hubverse-org/hubValidations") ``` -> ##### 💡 TIP +> [!NOTE] +> > `hubValidations` has a dependency on the `arrow` package. For troubleshooting `arrow` installation problems, please consult the [`arrow` package documentation](https://arrow.apache.org/docs/r/#installation). -> +> > You could also try installing the package from the [Apache R Universe repository](https://apache.r-universe.dev) with: -> +> > ```r > install.packages("arrow", repos = c("https://apache.r-universe.dev", "https://cran.r-project.org")) > ``` -*** +*** ## Code of Conduct Please note that the hubValidations 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? @@ -54,5 +66,7 @@ Learn more about how to [get involved in the Hubverse Community](https://hubvers ### Contributing new check functions -If submitting a new check function, please ensure you update `inst/check_table.csv` with metadata about the check. +If submitting a new check function, please ensure you update `inst/check_table.csv` with metadata about the check. See our [contributing guidelines](.github/CONTRIBUTING.md) for more details. + +