FishTaco 1.1.6
FishTaco: a metagenomic computational framework, aiming to identify the taxa that are driving functional shifts in microbiomes.



README.rst

=======
HISTORY
=======

====================
1.1.6 (25 May, 2021)
====================
* fixed type error with num_cv by specifying argument input type

====================
1.1.5 (24 May, 2021)
====================
* fixed type in read_csv file separator

========================
1.1.4 (5 November, 2020)
========================
* fixed bug that could cause OTU IDs to be read in as integers (caused problems when setting the dataframe index). Due to an underlying pandas bug, could be reverted if pandas is updated

=======================
1.1.3 (23 August, 2019)
=======================
* fixed bug in specifying FDR correction
* changed DA function statistics output file to include Bonferroni- and FDR-corrected significance values, rather than  just whether they passed the supplied alpha threshold
* added tests for FDR correction filtering and changing the alpha cutoff for differentially abundant functions

=======================
1.1.2 (22 August, 2019)
=======================
* fixed deprecated scikit-learn imports
* fixed swapped control and case sample numbers reported while running (this bug was only a display error, it had no effect on the results)
* added option to specify the number of folds for cross validation during genomic content inference
* added informative error message for when there are too few control and/or case samples for genomic content inference (given the number of folds)
* added option to specify the significance cutoff for multiple hypothesis corrections

========================
1.1.1 (20 October, 2016)
========================
* improved unit testing to include each individual function, as well as comparing the calculated FishTaco output to a pre-computed example output
* removed debugging statements from code
* added documentation to all functions
* resolved several runtime warnings for edge cases

=========================
1.1.0 (18 February, 2016)
=========================
* added the option to run FishTaco with no functional profile input, predicting it from the taxonomic profiles and genomic content inputs
* added a unit test for the option to run with no functional profiles input
* added the option to run FishTaco on only a subset of functions by supplying a list file as input

=====================
1.0.5 (15 July, 2015)
=====================
* Initial release




=======
Authors
=======

FishTaco is written and maintained by Ohad Manor and the Borenstein group in University of Washington.


FishTaco Software License Agreement

FishTaco (C) 2014-2016, University of Washington. All rights reserved.

Subject to the terms below, the University of Washington ("UW"), Professor Elhanan Borenstein, and Ohad Manor ("Developer(s)") give permission for you and other members of your laboratory for as long as they remain members ("Academic User(s)"), such permission granted solely to Academic Users in a nonprofit institution of higher education or a nonprofit research institution ("University"),  to use FishTaco solely as further detailed below. FishTaco is a computational framework for linking microbiome taxonomic and functional comparative analyses, for decomposing functional shifts observed in a comparative analysis into individual taxon-level contributions, and for identifying taxa that drive functional shifts in the microbiome. FishTaco is protected by a copyright. The National Institutes of Health supported work on FishTaco. The UW and the Developers allow Academic Users to perform, copy, and modify FishTaco, solely for internal, non-profit academic research purposes, and as long as Academic Users comply with the terms of this FishTaco Software License Agreement:

1. FishTaco is not used for any commercial purposes, or as part of a system which has commercial purposes. The FishTaco software remains at your University and is not published, distributed, or otherwise transferred or made available to other than Academic Users.

2. You may not distribute FishTaco or any modification to FishTaco to any third party.

If you wish to obtain FishTaco software for any commercial purposes, you will need to contact the University of Washington to see if rights are available and to negotiate a commercial license and pay a fee among other requirements. This includes, but is not limited to, using FishTaco to provide services to outside parties for a fee. In that case please contact:

UW CoMotion 
University of Washington
4311 11th Ave. NE,
Suite 500 Seattle, WA 98105-4608
Phone: (206) 543-3970
Email: license@uw.edu

3. You retain in FishTaco and any modifications to FishTaco, the copyright, trademark, patent or other notices pertaining to FishTaco as provided by UW.

4. You acknowledge that the Developers, the UW and its licensees may develop modifications to FishTaco that may be substantially similar to your modifications of FishTaco, and that the Developers, UW and its licensees shall not be constrained in any way by you in UW's or its licensees' use or management of such modifications. You acknowledge the right of the Developers and UW to prepare and publish modifications to FishTaco that may be substantially similar or functionally equivalent to your modifications and improvements, and if you obtain patent protection for any modification or improvement to FishTaco you agree not to allege or enjoin infringement of your patent by the Developers, the UW or by any of UW's licensees obtaining modifications or improvements to FishTaco from the University of Washington or the Developers.

5. If utilization of the FishTaco software results in outcomes which will be published, you will specify the version of FishTaco you used and cite the UW Developers.

6. Any risk associated with using the FishTaco software at your organization is with you and your organization. FishTaco is experimental in nature and is made available as a research courtesy "AS IS," expressly without any obligation by UW to provide accompanying services or support.

7. UW AND THE DEVELOPERS EXPRESSLY DISCLAIM ANY AND ALL WARRANTIES REGARDING THE SOFTWARE, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES PERTAINING TO MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

8. This Software License Agreement and all rights granted under it terminate on December 31st, 2020. Upon termination, you agree to remove so as to make unrecoverable the original FishTaco software, all copies and all modifications thereof.