Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 3.39 KB

README.md

File metadata and controls

60 lines (37 loc) · 3.39 KB
Raw

Galago

Demo | Rough roadmap | Status: prototype

This is a prototype repository for research related to making genomic epidemiology more accessible and interpretable through narrative and visual reports. Currently, galago is a serverless, standalone web application that ingests phylogenetic trees and renders responsive reports containing insights about clades or outbreaks of interest. Contact [email protected] with any questions or comments.

Using a Public Data Source

If you have a publicly available Nextstrain JSON tree, you can automatically fetch and use it by accessing the site through the fetch path.

https://galago.czgenepi.org/#/fetch/YOUR_DATA_URL_HERE
 --- for example... ---
https://galago.czgenepi.org/#/fetch/example.com/sometree.json

The above example would load Galago using the tree file specified at https://example.com/sometree.json. When no http[s] schema is present in the given URL, it automatically assumes it is an https schema. If you would like to specify the schema, you can enter it in the URL. For example, https://galago.czgenepi.org/#/fetch/http://example.com/another/tree/route would also be valid.

Specifying additional details about public data source

In addition to fetching a publicly available JSON tree via the fetch path, you can specify additional, optional pieces of information about the tree through the use of search (AKA query) params. For example:

https://galago.czgenepi.org/#/fetch/example.com/sometree.json?galagoPathogen=sarscov2&galagoMrca=Node47

This feature is still under active development. You can read more about its usage and what params are currently implemented by reading the source code documentation where it's implemented.

Development Process

git clone https://github.com/chanzuckerberg/galago.git
cd galago
npm install --save

Start up the development server: npm run dev

Build for deployment: npm run build

Data

Galago ingests the following data via user upload / input:

  • A tree file, in Nextstrain JSON format.
  • A list of sample IDs associated with a potential outbreak

In the future, we will also enable URL-based API ingestion and provide a demo dataset.

Security

Please note: If you believe you have found a security issue, please responsibly disclose by contacting us at [email protected]

Contributing

We warmly welcome contributions from the scientific and technical community! Please open an issue with suggestions, bug reports, and feature requests. We also welcome code contributions and PRs; please open an issue first describing the goal of your PR and your planned approach. Finally, we are in the process of transitioning all of our insight components to markdown to make direct contribution more accessible to fellow scientists -- stay tuned for updated contributor guidelines.

This project welcomes our whole community and is dedicated to preserving a constructive and inclusive culture. As such, we strictly adhere to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected] and we will take immediate action.