LDA.py¶
Create an LDA plot from sample-grouped OTU data. It is necessary to remove the header cell ‘#OTU ID’ before running this program.
usage: LDA.py [-h] -i BIOM_TSV -m MAP_FP -g GROUP_BY [GROUP_BY ...] -c COLOR_BY [--dpi DPI] [--save_lda_input SAVE_LDA_INPUT] [--plot_title PLOT_TITLE] [-o OUT_FP]
Required arguments¶
-
-iBIOM_TSV,--biom_tsvBIOM_TSV¶ Sample-OTU abundance table in TSV format with the arcsin sqrt transform already applied.
-
-mMAP_FP,--map_fpMAP_FP¶ Metadata mapping file.
Optional arguments¶
-
-gGROUP_BY [GROUP_BY ...],--group_byGROUP_BY [GROUP_BY ...]¶ Any mapping categories, such as treatment type, that will be used to group the data in the output iTol table. For example, one category with three types will result in three data columns in the final output. Two categories with three types each will result in six data columns. Default is no categories and all the data will be treated as a single group.
-
-cCOLOR_BY,--color_byCOLOR_BY¶ A column name in the mapping file containing hexadecimal (#FF0000) color values that will be used to color the groups. Each sample ID must have a color entry.
-
--dpiDPI¶ Set plot quality in Dots Per Inch (DPI). Larger DPI will result in larger file size.
-
--save_lda_inputSAVE_LDA_INPUT¶ Save a CSV-format file of the transposed LDA-input table to the file specifed by this option.
-
--plot_titlePLOT_TITLE¶ Plot title. Default is no title.
-
-oOUT_FP,--out_fpOUT_FP¶ The path and file name to save the plot under. If specified, the figure will be saved directly instead of opening a window in which the plot can be viewed before saving.
-
-h,--help¶ Show the help message and exit.