Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
zkamvar committed Sep 20, 2024
1 parent 5e9dfa2 commit fc3aa6e
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ output: github_document

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

```{r, include = FALSE}
```{r, include=FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
Expand All @@ -16,43 +16,57 @@ knitr::opts_chunk$set(
# hubValidations <a href="https://hubverse-org.github.io/hubValidations/"><img src="man/figures/logo.png" align="right" height="131" alt="hubValidations website" /></a>

<!-- badges: start -->

[![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)

<!-- badges: end -->

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?
Learn more about how to [get involved in the Hubverse Community](https://hubverse.io/en/latest/overview/contribute.html) or [how to contribute to hubValidations](.github/CONTRIBUTING.md).
### 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.

0 comments on commit fc3aa6e

Please sign in to comment.