Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address review comments. #22

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion adam-r/bdgenomics.adam/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Package: bdgenomics.adam
Type: Package
Version: 0.23.0
Title: R Frontend for Big Data Genomics/ADAM
Description: The SparkR package provides an R Frontend for Apache Spark.
Description: ADAM is a genomics analysis platform with specialized file formats built using Apache Avro, Apache Spark and Parquet.
Author: Big Data Genomics
Maintainer: Frank Austin Nothaft <fnothaft@alumni.stanford.edu>
Authors@R: c(person("Frank", "Nothaft", role = c("aut", "cre"),
Expand Down
14 changes: 11 additions & 3 deletions docs/source/02_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,17 @@ mvn -Pr package

This will enable the `adam-r` module as part of the ADAM build. This module
uses Maven to invoke the `R` executable to build the `bdg.adam` package and run
tests. Beyond having `R` installed, we require you to have the `SparkR` package
installed, and the ADAM JARs must be built and provided to `SparkR`. This can be
done with the following bash commands:
tests. The build requires the `testthat`, `devtools` and `roxygen` packages

```bash
R -e "install.packages('testthat', repos='http://cran.rstudio.com/')"
R -e "install.packages('roxygen2', repos='http://cran.rstudio.com/')"
R -e "install.packages('devtools', repos='http://cran.rstudio.com/')"
```

The build also requires you to have the `SparkR` package installed, and the
ADAM JARs must be built and provided to `SparkR`. This can be done with the
following bash commands:

```bash
# put adam jar on the SparkR path
Expand Down