Jennifer Shelton edited implementation.tex  over 8 years ago

Commit id: 533eb62c4e7caa2361b71bac0cc16a7faac2037c

deletions | additions      

       

\subsection{Portability}  Where possible Fasta-O-Matic was designed to be easy to distribute and use. Fasta-O-Matic is distributed on GitHub under a the MIT license to allow for easy access to or customization of the code. The tool was also built and tested on both Python2.7 and and Python3.3 to minimize incompatibility with existing linux environments. The script generates complete help menus when called from the command line with the \verb|--help| command and from within python with \ver|help(fasta_o_matic)|. \verb|help(fasta_o_matic)|.  Additionally, Fasta-O-Matic includes a sample FASTA file with missing newlines, inconsistent wrapping and spaces in headers and a tutorial which describes how to reformat the sample. These features ensure that Fasta-O-Matic is easy to incorporate into existing workflows. \subsection{Automate where appropriate}  

Inconsistent or unwrapped sequence lines, spaces in headers and missing or non-standard new lines are considered non-fatal errors. If they are detected the decision is made to reformat as requested, report the issue to the analyst and continue the workflow.  It also automatically adjusts to run the minimal number of steps sufficient to fix and report format issues. If it is included in the set of QC steps then wrapping is the first format issue tested because while repairing FASTA wrapping both headers and new lines can be corrected. New lines are given priority after wrapping because while repairing new lines it is also trivial to repair headers. Finally, headers are evaluated for format issues. If a early test returns a format issue and launches a reformatting that automatically repairs any remaining format issues it is still important to test for the remaining format errors. The analyst should be made aware of any unexpected format issues in case they indicate an unexpected issue with the data.