Skip to content

Commit

Permalink
#9 - Add travis ci integration.
Browse files Browse the repository at this point in the history
  • Loading branch information
hemp committed Dec 18, 2017
1 parent c61e7e6 commit d54ee76
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 19 deletions.
7 changes: 7 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
language: java
sudo: false
jdk:
- openjdk8
- openjdk9
script:
- mvn package
30 changes: 11 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# spark-vcf

Spark VCF data source implementation in native spark.

# Introduction
## Introduction

Spark VCF allows you to natively load VCFs into an Apache Spark Dataframe/Dataset. To get started with Spark-VCF, you can
clone or download this repository, then run `mvn package` and use the jar. We are also now in Maven central.

Since spark-vcf is written specifically for Spark, there is less overhead and performance gains in many areas.

# Installation
## Installation

Spark-vcf can be packaged from source or added as a dependency to your Maven based project.

Expand All @@ -32,7 +33,7 @@ If you are using gradle, the dependency is:
compile group: 'com.lifeomic', name: 'spark-vcf', version: '0.3.0'
```

# Getting Started
## Getting Started

Getting started with Spark VCF is as simple as:

Expand Down Expand Up @@ -81,24 +82,15 @@ the BGZFEnhancedGzipCodec from Hadoop-BAM for splitting bgzip files, so that Spa

```scala
val sparkConf = new SparkConf()
.setAppName("testing")
.setMaster("local[8]")
.set("spark.hadoop.io.compression.codecs", "org.seqdoop.hadoop_bam.util.BGZFEnhancedGzipCodec")
.setAppName("testing")
.setMaster("local[8]")
.set("spark.hadoop.io.compression.codecs", "org.seqdoop.hadoop_bam.util.BGZFEnhancedGzipCodec")
```

# TODO
* Provide performance benchmarks compared to other libraries
* Get Travis CI set up

# License

The MIT License
## TODO

Copyright 2017 Lifeomic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* Provide performance benchmarks compared to other libraries

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## License

[The MIT License](LICENSE)

0 comments on commit d54ee76

Please sign in to comment.