Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contribution-template.md #102

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update contribution-template.md #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions docs/contribute/contribution-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,25 @@ _We are actively seeking feedback and contributions from the community. This is

# Project title
## Solution Overview
Summarize your solution, project background, and key requirements.
MicrobeTrace is a free, intuitive, dynamic and flexible tool to integrate epidemiological and genomic data and deliver vibrant data visualizations. Using simple point-and-click interfaces, data from surveillance, epi investigations, and genetic analyses can be readily imported, integrated and visualized...no coding required. MicrobeTrace is delivered by a web browser but runs locally on your computer. This means data and analyses are not sent over the web.

### Use Cases
Detail the specific use cases or user stories that informed the requirements.
In spite of the plethora of data visualization tools available, we felt there was a need for easy to use tools that can integrate epi and genomic data wihout the need for informatics/ programming skills. MicrobeTrace accepts a variety of input files:
• Node lists (metadata)- CSV files
• Edge lists (Contact tracing information/ genetic distance information)- CSV files
• Molecular data- FASTA, NWK files, distance matrices
• JSON files

## Implementation Setup
Detail the technical setup steps for others to replicate or use your solution. Provide code snippets or link to source files, where applicable.
No downloads needed. Navigate to https://microbetrace.cdc.gov/MicrobeTrace/ and load files. The first time you use MicrobeTrace, an instance is downloaded onto your machine. After that, MicrobeTrace cab even be run without internet access.

## Learn More
Provide other resources, tools, and contact information if users have questions.
General MicrobeTrace resources:
• MicrobeTrace tutorial. https://youtu.be/O52eeyUbpIoexternal icon
• MicrobeTrace- the tool https://microbetrace.cdc.gov
• MicrobeTrace documentation. https://github.com/CDCgov/MicrobeTrace/wikiexternal icon
COVID- specific resources
• MicrobeTrace for COVID data: https://youtu.be/he0Yq5yvToc
• Genomics toolkit https://www.cdc.gov/amd/training/covid-19-gen-epi-toolkit.html (Scroll down to module 3.2)
• Training Powerpoints, manuals etc. https://github.com/CDCgov/MicrobeTrace/raw/master/demo/COVID Dummy Data.zip