Developer documentation
The OmicIDX project has several components available under the Github omicidx organization. Repositories include:
Parsers
URL: https://github.com/omicidx/omicidx-parsers
The parsers repository houses parsers that transform omics metadata from their original source formats to JSON. Because repositories have distinct approaches for exposing their metadata, parsers also includes tooling for accessing web APIs or metadata database dumps. The main use case for parsers is to serve as a library for builder. However, it may be useful for others who want to parse omicidx metadata from sratch.
Builder
URL: https://github.com/omicidx/omicidx-builder
The builder repository contains tooling for building from the original
source the Bigquery, REST API, and downloadable resources. Most
functionality is included in a single executable, omicidx-builder.
Note: Some features of builder require a Google Bigquery account.
Website and documentation
URL: https://github.com/omicidx/omicidx-docs
The materials for this website are housed in this repository. The website itself if built using [blogdown] and [hugo].
[blogdown]: [hugo]:
REST API
Server
Clients
GraphQL
Server
Clients
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.