Learn R Programming

SQMtools (version 1.6.3)

loadSQMlite: Load tables generated by sqm2tables.py, sqmreads2tables.py or combine-sqm-tables.py into R.

Description

This function takes the path to the output directory generated by sqm2tables.py, sqmreads2tables.py or combine-sqm-tables.py a SQMlite object. The SQMlite object will contain taxonomic and functional profiles, but no detailed information on ORFs, contigs or bins. However, it will also have a much smaller memory footprint. A SQMlite object can be used for plotting and exporting, but it can not be subsetted.

Usage

loadSQMlite(tables_path, tax_mode = "allfilter")

Value

SQMlite object containing the parsed tables.

Arguments

tables_path

character, tables directory generated by sqm2table.py, sqmreads2tables.py or combine-sqm-tables.py.

tax_mode

character, which taxonomic classification should be loaded? SqueezeMeta applies the identity thresholds described in Luo et al., 2014. Use allfilter for applying the minimum identity threshold to all taxa (default), prokfilter for applying the threshold to Bacteria and Archaea, but not to Eukaryotes, and nofilter for applying no thresholds at all.

The SQMlite object structure

The SQMlite object is a nested list which contains the following information:

lvl1lvl2lvl3typerows/namescolumnsdata
$taxa$superkingdom$abundnumeric matrixsuperkingdomssamplesabundances
$percentnumeric matrixsuperkingdomssamplespercentages
$phylum$abundnumeric matrixphylasamplesabundances
$percentnumeric matrixphylasamplespercentages
$class$abundnumeric matrixclassessamplesabundances
$percentnumeric matrixclassessamplespercentages
$order$abundnumeric matrixorderssamplesabundances
$percentnumeric matrixorderssamplespercentages
$family$abundnumeric matrixfamiliessamplesabundances
$percentnumeric matrixfamiliessamplespercentages
$genus$abundnumeric matrixgenerasamplesabundances
$percentnumeric matrixgenerasamplespercentages
$species$abundnumeric matrixspeciessamplesabundances
$percentnumeric matrixspeciessamplespercentages
$functions$KEGG$abundnumeric matrixKEGG idssamplesabundances (reads)
$basesnumeric matrixKEGG idssamplesabundances (bases)
$tpmnumeric matrixKEGG idssamplestpm
$copy_numbernumeric matrixKEGG idssamplesavg. copies
$COG$abundnumeric matrixCOG idssamplesabundances (reads)
$basesnumeric matrixCOG idssamplesabundances (bases)
$tpmnumeric matrixCOG idssamplestpm
$copy_numbernumeric matrixCOG idssamplesavg. copies
$PFAM$abundnumeric matrixPFAM idssamplesabundances (reads)
$basesnumeric matrixPFAM idssamplesabundances (bases)
$tpmnumeric matrixPFAM idssamplestpm
$copy_numbernumeric matrixPFAM idssamplesavg. copies
$total_readsnumeric vectorsamples(n/a)total reads
$misc$project_namecharacter vector(empty)(n/a)project name
$samplescharacter vector(empty)(n/a)samples
$tax_names_long$superkingdomcharacter vectorshort names(n/a)full names
$phylumcharacter vectorshort names(n/a)full names
$classcharacter vectorshort names(n/a)full names
$ordercharacter vectorshort names(n/a)full names
$familycharacter vectorshort names(n/a)full names
$genuscharacter vectorshort names(n/a)full names
$speciescharacter vectorshort names(n/a)full names
$tax_names_shortcharacter vectorfull names(n/a)short names
$KEGG_namescharacter vectorKEGG ids(n/a)KEGG names
$KEGG_pathscharacter vectorKEGG ids(n/a)KEGG hiararchy
$COG_namescharacter vectorCOG ids(n/a)COG names
$COG_pathscharacter vectorCOG ids(n/a)COG hierarchy
$ext_annot_sourcescharacter vector(empty)(n/a)external databases
If external databases for functional classification were provided to SqueezeMeta or SqueezeMeta_reads via the -extdb argument, the corresponding abundance, tpm and copy number profiles will be present in SQM$functions (e.g. results for the CAZy database would be present in SQM$functions$CAZy). Additionally, the extended names of the features present in the external database will be present in SQM$misc (e.g. SQM$misc$CAZy_names). Note that results generated by SqueezeMeta_reads will contain only read abundances, but not bases, tpm or copy number estimations.

See Also

plotBars and plotFunctions will plot the most abundant taxa and functions in a SQMlite object. exportKrona will generate Krona charts reporting the taxonomy in a SQMlite object.