Skip to content

Commit

Permalink
Updated documentation to reflect the existence of the dataonelibs pac…
Browse files Browse the repository at this point in the history
…kage now.
  • Loading branch information
mbjones committed Feb 25, 2013
1 parent bc3adf8 commit 51f1453
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,19 @@ An R_ package that provides read/write access to data and metadata from the Data

Downloads
---------
The currently supported version is:
The currently supported version requires two R packages, dataone and dataonelibs (which provides the Java libraries necessary for the dataone package to function):

- DataONE R Client (dataone_1.0.0.tar.gz_)
- DataONE Libraries (dataonelibs_1.0.0.tar.gz_)

Documentation for the DataONE R Client is provided as help files within the R framework, and is downloadable in PDF format:

- DataONE R Client Manual (dataone_1.0.0-manual.pdf_)

.. _dataone_1.0.0.tar.gz: https://releases.dataone.org/dist/dataone_1.0.0.tar.gz

.. _dataonelibs_1.0.0.tar.gz: https://releases.dataone.org/dist/dataonelibs_1.0.0.tar.gz

.. _dataone_1.0.0-manual.pdf: https://releases.dataone.org/dist/dataone_1.0.0-manual.pdf

Installation Notes
Expand All @@ -27,6 +30,8 @@ The easiest way to install the client is via the CRAN_ repository:

..

> install.packages("dataonelibs")

> install.packages("dataone")


Expand All @@ -37,7 +42,9 @@ site above and, after downloading the package, install it using:

..

$ R CMD install dataone_1.0.0.tar.gz
$ R CMD install dataonelibs_1.0.0.tar.gz

$ R CMD install dataone_1.0.0.tar.gz

This package uses rJava to bind to the Java client libraries. Be sure to install
rJava for your particular version of R and Java.
Expand All @@ -56,6 +63,8 @@ Once installed, the package can be run in R using:

Loading required package: XML

Loading required package: dataonelibs

> help(dataone)


Expand Down
2 changes: 1 addition & 1 deletion dataone/man/dataone-package.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ the DataONE network of Member Node data repositories.
Package: \tab dataone\cr
Version: \tab 1.0.0\cr
Date: \tab 2013-02-14\cr
Depends: \tab R (>= 2.9.2), rJava (>= 0.8-5), XML (>= 3.95-0.1), methods\cr
Depends: \tab R (>= 2.9.2), rJava (>= 0.8-5), XML (>= 3.95-0.1), methods, dataonelibs\cr
Imports: \tab rJava, XML\cr
SystemRequirements: \tab Java (>= 1.6)\cr
License: \tab file LICENSE\cr
Expand Down

0 comments on commit 51f1453

Please sign in to comment.