Skip to content

Commit

Permalink
Rename to "htsget", the newly-chosen name for the protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
jmarshall committed Jan 31, 2017
1 parent ff9df33 commit 9692681
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ These formats are discussed on the [vcftools-spec mailing list][vcfspec-ml].
Transfer protocols
------------------

The **[ga4gh-retrieval.md]** protocol enables parallel streaming access to data sharded across multiple URLs or files.
**[Htsget.md]** describes the _hts-get_ retrieval protocol, which enables parallel streaming access to data sharded across multiple URLs or files.

[SAMv1.tex]: http://samtools.github.io/hts-specs/SAMv1.pdf
[SAMtags.tex]: http://samtools.github.io/hts-specs/SAMtags.pdf
Expand All @@ -42,7 +42,7 @@ The **[ga4gh-retrieval.md]** protocol enables parallel streaming access to data
[VCFv4.3.tex]: http://samtools.github.io/hts-specs/VCFv4.3.pdf
[BCFv1_qref.tex]: http://samtools.github.io/hts-specs/BCFv1_qref.pdf
[BCFv2_qref.tex]: http://samtools.github.io/hts-specs/BCFv2_qref.pdf
[ga4gh-retrieval.md]: http://samtools.github.io/hts-specs/ga4gh-retrieval.html
[Htsget.md]: http://samtools.github.io/hts-specs/htsget.html

[ena-cram]: http://www.ebi.ac.uk/ena/about/cram_toolkit
[htslib]: https://github.com/samtools/htslib
Expand Down
6 changes: 3 additions & 3 deletions ga4gh-retrieval.md → htsget.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: default
title: Retrieval API spec v0.1
title: htsget protocol
suppress_footer: true
---

# Retrieval API spec v0.1
# Htsget retrieval API spec v0.1

# Design principles

Expand Down Expand Up @@ -223,7 +223,7 @@ MD5 digest of the blob resulting from concatenating all of the "payload" data --

### Diagram of core mechanic

![Diagram showing ticket flow](pub/ga4gh-ticket.png)
![Diagram showing ticket flow](pub/htsget-ticket.png)

1. Client sends a request with id, genomic range, and filter.
2. Server replies with a ticket describing data block locations (URLs and headers).
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Specifications:
- [VCF v4.1](VCFv4.1.pdf)
- [VCF v4.2](VCFv4.2.pdf)
- [VCF v4.3](VCFv4.3.pdf)
- [GA4GH retrieval](ga4gh-retrieval.html)
- [Htsget](htsget.html)
</div>
<div class="mainbar">
{% for line in readme_lines offset: 5 %}
Expand Down
File renamed without changes

0 comments on commit 9692681

Please sign in to comment.