diff --git a/Home.md b/Home.md index 3feeffd..9a3c805 100644 --- a/Home.md +++ b/Home.md @@ -1,27 +1,26 @@ # Overview: -The core PhyloToL pipeline comprises two main components, which we refer to as PhyloToL part one and part two. PhyloToL part one takes input sequences from a whole genome or transcriptome assembly, applies several curation steps, and provides initial homology assessment against a customizable database of reference sequences to assign GFs. Part one outputs a fasta file of curated nucleotide and amino acid sequences with gene families assigned, as well as a dataset of descriptive statistics (e.g. length, coverage, and composition) for each input sample. PhyloToL part 2 is highly modular; for a given selection of taxa and GFs it stringently assesses homology by iterating the tool Guidance (Penn et al., 2010; Sela et al., 2015), which outputs an MSA for each gene family. From MSAs it builds gene trees, and then includes an innovative workflow for tree topology-based contamination removal. +PhyloToL version 6 is designed to be a modular, accessible pipeline that includes sophisticated data curation methods, including a newly designed method of phylogeny-informed contamination removal, gene families homology estimation, and generation multisequence alignments (MSAs) and gene trees. -We also provide +The core PhyloToL pipeline comprises two main components, which we refer to as PhyloToL parts I and II. PhyloToL part 1 takes input sequences from a whole genome or transcriptome assembly, applies several curation steps, and provides initial homology assessment against a customizable database of reference sequences to assign GFs. Part one outputs a fasta file of curated nucleotide and amino acid sequences with gene families assigned, as well as a dataset of descriptive statistics (e.g. length, coverage, and composition) for each input sample. PhyloToL part 2 is highly modular; for a given selection of taxa and GFs it stringently assesses homology by iterating the tool Guidance (Penn et al., 2010; Sela et al., 2015), which outputs an MSA for each gene family. From MSAs it builds gene trees, and then includes an innovative workflow for tree topology-based contamination removal. + +We also provide a suite of utility scripts for describing data output by PhyloToL (e.g. basic sequence statistics such as composition, coverage, and length) as well as performing some of PhyloToL's more complex operations (e.g. "clade-grabbing") in a stand-alone form. # Table of Contents -## PhyloToL Part I = determining gene families -* Overview +## PhyloToL Part 1 +* [Overview & modularity](https://github.com/Katzlab/PhyloToL-6/wiki/PTL1-Overview) * [Set up](https://github.com/Katzlab/PhyloToL-6/wiki/Set-up) -* The Hook reference database for gene family assigment -* [Processing transcriptomes](https://docs.google.com/document/d/1pXMPZwK17yfk5-kIGYzwTSTO-5ggoMq-5II16nAPWAo/edit#heading=h.masnnqe0fycn) -* [Processing genomes](https://docs.google.com/document/d/1pXMPZwK17yfk5-kIGYzwTSTO-5ggoMq-5II16nAPWAo/edit#heading=h.15uyieg4qumy) with CDs -* [Starting at different points in the process](https://docs.google.com/document/d/1pXMPZwK17yfk5-kIGYzwTSTO-5ggoMq-5II16nAPWAo/edit#heading=h.sjrzmygryaj4) (Folder structure) +* [The Hook Database](https://github.com/Katzlab/PhyloToL-6/wiki/Hook) +* [Processing transcriptomes](https://github.com/Katzlab/PhyloToL-6/wiki/Processing-transcriptomes) +* [Processing genomes](https://github.com/Katzlab/PhyloToL-6/wiki/Processing-genomes) -## PhyloToL Part 2 = generating MSAs and gene trees -* Overview of the process -* Producing and curating MSAs -* Filtering by composition -* [Building gene trees](https://docs.google.com/document/d/1pXMPZwK17yfk5-kIGYzwTSTO-5ggoMq-5II16nAPWAo/edit#heading=h.5f0xducehljc) -* Contamination loop: phylogeny-informed contamination removal +## PhyloToL Part 2 +* [Overview & modularity](https://github.com/Katzlab/PhyloToL-6/wiki/PTL2-Overview) +* [Overlap and similarity filters](https://github.com/Katzlab/PhyloToL-6/wiki/pre-Guidance) +* [Guidance](https://github.com/Katzlab/PhyloToL-6/wiki/Guidance) +* [Building gene trees](https://github.com/Katzlab/PhyloToL-6/wiki/Trees) +* [Contamination loop: phylogeny-informed contamination removal](https://github.com/Katzlab/PhyloToL-6/wiki/Contamination-loop) -## Utilities - -## Troubleshooting Guide - -## Appendices \ No newline at end of file +## Other +* [Utility scripts](https://github.com/Katzlab/PhyloToL-6/wiki/Utilities) +* [Troubleshooting](https://github.com/Katzlab/PhyloToL-6/wiki/Troubleshooting) \ No newline at end of file