Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
seppinho authored Jul 17, 2024
1 parent 60eb2ac commit ee2dcc5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,18 @@ Returns VCF summary attributes (chromosomes, variantCount, sampleCount, phasing
```groovy
path("file.vcf.gz").vcf.summary
```
### `chromosomes()`
Returns all chromosomes as a set of Strings.
```groovy
path("file.vcf.gz").vcf.chromosomes == ['20'] as Set
```
### `chromosome()`
Returns the first chromosome as a String.
```groovy
path("file.vcf.gz").vcf.chromosome == '20'
```

### `getVariant(String chromosome, String position)`
Returns a [VariantContext](https://samtools.github.io/htsjdk/javadoc/htsjdk/htsjdk/variant/variantcontext/VariantContext.html) instance and allows you to access all available methods.
```groovy
Expand Down

0 comments on commit ee2dcc5

Please sign in to comment.