Create a text report based on a Genome object.
This intended purpose of this App is to produce downloadable TEXT reports.
Most KBase data objects already have some type of viewable HTML table, either as output from an App or by dragging the object onto the Narrative. This App serves a different purpose. It creates data files that are downloadable and used with local tools such as Excel or informatic scripts.
This App creates reports on a Genome. Short reports will display as TEXT in the Summary section of the output. Longer reports will instead have a link to open the TEXT in a new html browser tab. There is a link for downloading the file in the Files section of the output. Whether short or long, the Summary/Link section is intended to be a preview of the downloadable file. If the report is tab or comma delimited, it may appear misaligned on the screen but readable by a computer script.
Inputs:
- The KBase Genome object.
- A download option:
- DNA FASTA format. Create a FASTA file of the genomic DNA.
- Features, Tab-delimited. A report where the rows are the genes in the Genome and the columns are information about the genes. Columns are separated with tabs.
- Features, Comma-delimited. A report where the rows are the genes in the Genome and the columns are information about the genes. Columns are separated with commas.
- Features, GFF3 format. A GFF3 (General Feature Format) file of the genes in the Genome.
- FASTA, translated CDSs. A FASTA-formatted file of the amino acid sequences of the genes.
- FASTA, of mRNAs. A FASTA-formatted file of the mRNA sequences of the genes.
Output:
- The Summary or Link section has text version of the requested file.
- One downloadable file in the Files section. The name and content of the file will depend on the requested file format.
- FASTA files will be in FASTA format. The file name will end in .fna for nucleotide files and .faa for amino acid files.
- Feature lists will include the FeatureID, Feature Type, Contig, Location (Feature Coordinates), Strand, Feature Function, and, if applicable, Aliases. Tab-delimited, comma-delimited, and GFF files will end in .tab, .csv and .gff, respectively.
Related Publications
- Arkin AP, Cottingham RW, Henry CS, Harris NL, Stevens RL, Maslov S, et al. KBase: The United States Department of Energy Systems Biology Knowledgebase. Nature Biotechnology. 2018;36: 566. doi: 10.1038/nbt.4163 , https://www.nature.com/articles/nbt.4163
App Specification:
https://github.com/landml/Report_util_landml/tree/4beb145b1eb72199cb874a42ba9117413a6d3794/ui/narrative/methods/genome_reportModule Commit: 4beb145b1eb72199cb874a42ba9117413a6d3794