Create a text report based on a GenomeSet 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 the Genomes in a GenomeSet. 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 files in the Files section of the outout. 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 GenomeSet object.
- A download option:
- Metadata: Minimal information. A report on the metadata for the GenomeSet, including, name, object type, author/creator, narrative ID, GenomeSet description, and a list of the KBase-relevant Genome IDs in the set.
- Vertical. List information on each of the Genomes in a vertical report instead of columns. Easy-to-read format but more difficult to visually compare one Genome to the others.
- Tab-delimited. A report with tab-delimited columns.
- Comma-delimited. A report with comma-delimited columns.
- DNA Fasta. A report with the DNA FASTA of each of the Genomes. NOTE: this is really long.
Output:
- The Summary or Link section has a 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.
- The metadata contains minimum information about the set and the genome references that are part of the set.
- FASTA files will be in FASTA format. The file name will end in .fna for nucleotide files and .faa for amino acid files.
- The other reports contain summary statistics about the genomes in the set. The differences are just in the format of the information.
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/genomeset_reportModule Commit: 4beb145b1eb72199cb874a42ba9117413a6d3794