Skip to content

Commit

Permalink
Clarify the installation of rdataretriever
Browse files Browse the repository at this point in the history
Either install the `Cran` release version  or `Github` dev version

```coffee
  devtools::install_github("ropensci/rdataretriever") # from GitHub
  install.packages("rdataretriever")# from CRAN
```
  • Loading branch information
henrykironde committed May 23, 2019
1 parent 2c196fb commit 872cdd6
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ handling can easily be integrated into R workflows.
`rdataretriever` is an R wrapper for the Python based Data Retriever. This means
that Python and the `retriever` package need to be installed first.

#### Installation from `CRAN` and `PyPi`
#### Installation from `CRAN` and `conda` or `Anaconda`

*Use this if you are new to Python or don't have a local Python installation*

Expand All @@ -54,14 +54,15 @@ that Python and the `retriever` package need to be installed first.
4. Install the `rdataretriever` R package:

```coffee
devtools::install_github("ropensci/rdataretriever")
install.packages("rdataretriever") # from CRAN
devtools::install_github("ropensci/rdataretriever") # from GitHub
```

#### Installation with `devtools` and `reticulate`
#### Installation with `devtools`

*Use this if you are already familiar with Python and have a local Python installation*

1. Check that your local Python installation is Python 3
1. Check that your local Python installation is Python 3.6 and above
2. In R install the `reticulate` package:

```coffee
Expand All @@ -79,9 +80,10 @@ that Python and the `retriever` package need to be installed first.
4. Install the `rdataretriever` R package:

```coffee
devtools::install_github("ropensci/rdataretriever")
devtools::install_github("ropensci/rdataretriever") # from GitHub
install.packages("rdataretriever") # from CRAN
```

Examples
--------
```coffee
Expand Down Expand Up @@ -182,7 +184,7 @@ To run tests
Release
-------

Make sure you have test passing on R-oldrelease, current R-release and R-devel
Make sure you have tests passing on R-oldrelease, current R-release and R-devel

To check the package

Expand Down

0 comments on commit 872cdd6

Please sign in to comment.