-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
70 lines (47 loc) · 2.59 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
---
output: github_document
---
<!-- 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%"
)
```
# hubData <a href="https://hubverse-org.github.io/hubData/"><img src="man/figures/logo.png" align="right" height="131" alt="hubData website" /></a>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://CRAN.R-project.org/package=hubData)
[](https://github.com/hubverse-org/hubData/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of hubData is to provide tools for accessing and working with hubverse Hub data.
This package is part of the [hubverse](https://hubverse.io/en/latest/) ecosystem, which aims to provide a set of tools for infectious disease modeling hubs to share and collaborate on their work.
## Installation
### Latest
You can install the [latest version of hubData from the R-universe](https://hubverse-org.r-universe.dev/hubData):
```r
install.packages("hubData", 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 hubData from [GitHub](https://github.com/) with:
```r
# install.packages("remotes")
remotes::install_github("hubverse-org/hubData")
```
> [!NOTE]
>
> `hubData` 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 hubData 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 hubData package](.github/CONTRIBUTING.md).