Skip to content

Commit 3495041

Browse files
committed
add install instructions to readme to close #106; thanks @drmowinckels
1 parent e98800e commit 3495041

File tree

4 files changed

+52
-2
lines changed

4 files changed

+52
-2
lines changed

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: deposits
22
Title: A universal client for depositing and accessing research data
33
anywhere
4-
Version: 0.2.1.060
4+
Version: 0.2.1.061
55
Authors@R:
66
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
77
comment = c(ORCID = "0000-0003-2172-5265"))

README.Rmd

+25
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,31 @@ who prefer to jump straight in to a workflow, there is also a deposits
4040
demonstrating a full workflow from data generation and documentation to
4141
publication.
4242

43+
## Installation
44+
45+
The package can be installed by enabling the "ropenscilabs" repository from
46+
[r-universe](https://ropenscilabs.r-universe.dev):
47+
48+
```{r}
49+
options (repos = c (
50+
ropenscilabs = "https://ropenscilabs.r-universe.dev",
51+
CRAN = "https://cloud.r-project.org"
52+
))
53+
```
54+
55+
The `install.packages()` command will then install the development version.
56+
Alternatively, the package can be installed with:
57+
58+
```{r gh-installation, eval = FALSE}
59+
# install.packages("remotes")
60+
remotes::install_github ("mpadge/deposits")
61+
```
62+
63+
The package can then be loaded the usual way:
64+
```{r load-fakey, eval = TRUE}
65+
library (deposits)
66+
```
67+
4368
## Data Repositories
4469

4570
The list of data repositories currently supported is accessible by the

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,31 @@ vignette](https://docs.ropensci.org/deposits/articles/workflow.html)
3434
demonstrating a full workflow from data generation and documentation to
3535
publication.
3636

37+
## Installation
38+
39+
The package can be installed by enabling the "ropenscilabs" repository from
40+
[r-universe](https://ropenscilabs.r-universe.dev):
41+
42+
``` r
43+
options (repos = c (
44+
ropenscilabs = "https://ropenscilabs.r-universe.dev",
45+
CRAN = "https://cloud.r-project.org"
46+
))
47+
```
48+
49+
The `install.packages()` command will then install the development version.
50+
Alternatively, the package can be installed with:
51+
52+
``` r
53+
# install.packages("remotes")
54+
remotes::install_github ("mpadge/deposits")
55+
```
56+
57+
The package can then be loaded the usual way:
58+
``` r
59+
library (deposits)
60+
```
61+
3762
## Data Repositories
3863

3964
The list of data repositories currently supported is accessible by the

codemeta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"codeRepository": "https://github.com/ropenscilabs/deposits",
88
"issueTracker": "https://github.com/ropenscilabs/deposits/issues",
99
"license": "https://spdx.org/licenses/MIT",
10-
"version": "0.2.1.060",
10+
"version": "0.2.1.061",
1111
"programmingLanguage": {
1212
"@type": "ComputerLanguage",
1313
"name": "R",

0 commit comments

Comments
 (0)