search

phac-nml / staramr

Scans genome contigs against the ResFinder, PlasmidFinder, and PointFinder databases.
Apache License 2.0
113 stars 26 forks source link

Updated README.md to include PlasmidFinder #57

Closed jennifertran closed 5 years ago

jennifertran commented 5 years ago

Based on issue #55

Problem

The README.md file and the tutorial no longer reflects the current state of staramr now that PlasmidFinder has been added to the codebase.

Solution

Update the README.md file and the staramr tutorial thats made in Juypter

Implementation

  1. Replace the command examples in the README.md file with images generated from https://carbon.now.sh with the Monokai theme with Droid Sans Mono Font
  2. Go through the entire README.md file to include PlasmidFinder as well as new output generated from plasmidfinder.tsv and detailed_summary.tsv
  3. Run through the tutorial again on Juypter and replace any output or include new output generated from staramr

Testing

Manually done through the command line to see if it gives out my expected output

apetkau commented 5 years ago

Thanks so much @jennifertran, everything looks great :+1: . I'll just wait for the tests to run before merging.