Skip to content

Commit

Permalink
add install instructions to readme to close #106; thanks @drmowinckels
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Sep 5, 2024
1 parent e98800e commit 3495041
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: deposits
Title: A universal client for depositing and accessing research data
anywhere
Version: 0.2.1.060
Version: 0.2.1.061
Authors@R:
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-2172-5265"))
Expand Down
25 changes: 25 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,31 @@ who prefer to jump straight in to a workflow, there is also a deposits
demonstrating a full workflow from data generation and documentation to
publication.

## Installation

The package can be installed by enabling the "ropenscilabs" repository from
[r-universe](https://ropenscilabs.r-universe.dev):

```{r}
options (repos = c (
ropenscilabs = "https://ropenscilabs.r-universe.dev",
CRAN = "https://cloud.r-project.org"
))
```

The `install.packages()` command will then install the development version.
Alternatively, the package can be installed with:

```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github ("mpadge/deposits")
```

The package can then be loaded the usual way:
```{r load-fakey, eval = TRUE}
library (deposits)
```

## Data Repositories

The list of data repositories currently supported is accessible by the
Expand Down
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,31 @@ vignette](https://docs.ropensci.org/deposits/articles/workflow.html)
demonstrating a full workflow from data generation and documentation to
publication.

## Installation

The package can be installed by enabling the "ropenscilabs" repository from
[r-universe](https://ropenscilabs.r-universe.dev):

``` r
options (repos = c (
ropenscilabs = "https://ropenscilabs.r-universe.dev",
CRAN = "https://cloud.r-project.org"
))
```

The `install.packages()` command will then install the development version.
Alternatively, the package can be installed with:

``` r
# install.packages("remotes")
remotes::install_github ("mpadge/deposits")
```

The package can then be loaded the usual way:
``` r
library (deposits)
```

## Data Repositories

The list of data repositories currently supported is accessible by the
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"codeRepository": "https://github.com/ropenscilabs/deposits",
"issueTracker": "https://github.com/ropenscilabs/deposits/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.2.1.060",
"version": "0.2.1.061",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down

0 comments on commit 3495041

Please sign in to comment.