Skip to content

Commit

Permalink
Merge pull request #1454 from ashishpriyadarshiCIC/doc_r_update
Browse files Browse the repository at this point in the history
Link for rdataretriever added
  • Loading branch information
henrykironde committed Mar 25, 2020
2 parents 2eb4ab5 + c1c7cce commit 24e4dac
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/rdataretriever.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
Using the Data Retriever from R
===============================

rdataretriever
==============
rdataretriever_
===============

The `Data Retriever`_ provides an R interface to the Data Retriever so
that the ``retriever``'s data handling can easily be integrated into R workflows.

Installation
============

To use the R package ``rdataretriever``, you first need to `install the retriever <introduction.html#installing-binaries>`_.
To use the R package rdataretriever_, you first need to `install the retriever <introduction.html#installing-binaries>`_.

The ``rdataretriever`` can then be installed using
The rdataretriever_ can then be installed using
``install.packages("rdataretriever")``

To install the development version, use ``devtools``
Expand All @@ -26,7 +26,7 @@ To install the development version, use ``devtools``

Note: The R package takes advantage of the Data Retriever's command line
interface, which must be available in the path. This path is given to the
``rdataretriever`` using the function ``use_RetrieverPath()``. The location of
rdataretriever_ using the function ``use_RetrieverPath()``. The location of
``retriever`` is dependent on the Python installation (Python.exe, Anaconda, Miniconda),
the operating system and the presence of virtual environments in the system. The following instances
exemplify this reliance and how to find retriever's path.
Expand Down Expand Up @@ -265,3 +265,4 @@ To get citation information for the ``rdataretriever`` in R use ``citation(packa


.. _Data Retriever: http://data-retriever.org
.. _rdataretriever: https://github.com/ropensci/rdataretriever

0 comments on commit 24e4dac

Please sign in to comment.