How to run the Type Among Multiple Species workflow

To run the workflow for one or more samples containing multiple species, go to

        Toolbox | Template Workflows (Image workflow_group) | Microbial Workflows (Image mgm_folder_closed_flat_16_h_p) | Typing and Epidemiology (Image typing_epi_folder_closed_16_h_p) | Type Among Multiple Species (Image type_multispecies_16_h_p)

  1. Specify the sample(s) or folder(s) of samples you would like to type (figure 13.51) and click Next. Remember that if you select several items, they will be run as batch units.

    Image typeamongmultiplespecies_samples
    Figure 13.51: Select the reads from the sample(s) you would like to type.

  2. Specify the Result Metadata Table you want to use (figure 13.52) and click Next.

    Image typeamongmultiplespecies_metadata
    Figure 13.52: Select the metadata table you would like to use.

  3. Define batch units using organisation of input data to create one run per input or use a metadata table to define batch units. Click Next.

  4. The next wizard window gives you an overview of the samples present in the selected folder(s). Choose which of these samples you want to analyze in case you are not interested in analyzing all the samples from a particular folder (figure 13.53).

    Image typeamongmultiplespecies_batch
    Figure 13.53: Choose which of the samples present in the selected folder(s) you want to analyze.

  5. You can specify a trim adapter list and set up parameters if you would like to trim your sequences from adapters. Specifying a trim adapter list is optional but recommended to ensure the highest quality data for your typing analysis (figure 13.54). Learn about trim adapter lists at http://resources.qiagenbioinformatics.com/manuals/clcgenomicsworkbench/current/index.php?manual=Trim_adapter_list.html.

    Image typeamongmultiplespecies_trim
    Figure 13.54: You can choose to trim adapter sequences from your sequencing reads.

    The parameters that can be set are:

    • Trim ambiguous nucleotides: if checked, this option trims the sequence ends based on the presence of ambiguous nucleotides (typically N).
    • Maximum number of ambiguities: defines the maximal number of ambiguous nucleotides allowed in the sequence after trimming.
    • Trim using quality scores: if checked, and if the sequence files contain quality scores from a base-caller algorithm, this information can be used for trimming sequence ends.
    • Quality limit: defines the minimal value of the Phred score for which bases will not be trimmed.
    Click Next.

  6. Choose the species-specific references to be used by the Find Best Matches using K-mer Spectra tool (figure 13.55). The list can be a fully customized list, the downloaded bacterial genomes from NCBI list (see section 18.1.1) or a subset of it. Click Next.

    Image typeamongmultiplespecies_spectra
    Figure 13.55: Specify the references for the Find Best Matches using K-mer Spectra tool.

  7. Specify MLST schemes to be used for the Identify MLST Scheme from Genomes tool so they correspond to corresponding to the chosen reference list(s) (figure 13.56).

    Image typeamongmultiplespecies_identify
    Figure 13.56: Specify the schemes that best describe your sample(s).

  8. Specify the resistance database (figure 13.57) and set the parameters for the Find Resistance with Nucleotide DB tool.

    Image typeamongmultiplespecies_resistanceDB
    Figure 13.57: Specify the resistance database to be used for the Find Resistance with Nucleotide DB tool.

    The parameters that can be set are:

    • Minimum Identity %: is the threshold for the minimum percentage of nucleotides that are identical between the best matching resistance gene in the database and the corresponding sequence in the genome.
    • Minimum Length %: reflect the percentage of the total resistance gene length that a sequence must overlap a resistance gene to count as a hit for that gene. Here represented as a percentage of the total resistance gene length.
    • Filter overlaps: will perform extra filtering of results per contig, where one hit is contained by the other with a preference for the hit with the higher number of aligned nucleotides (length * identity).

    Click Next.

  9. Specify the parameters for the Type with MLST Scheme tool (figure 13.58).

    Image typeamongmultiplespecies_parameters
    Figure 13.58: Specify the parameters for MLST typing.

    The parameters that can be set are:

    • Kmer size: determines the number of nucleotides in the kmer - raising this setting might increase specificity at the cost of some sensitivity.
    • Typing threshold: determines how many of the kmers in a sequence type that needs to be identified before a typing is considered conclusive. The default setting of 1.0 means that all kmers in all alleles must be matched.
    • Minimum kmer ratio: the minimum kmer ratio of the least occurring kmer and the average kmer hit count. If an allele scores higher than this threshold it is classified as a high-confidence call.

    Click Next.

  10. Specify the parameters for the Fixed Ploidy Variant Detection tool (figure 13.59) before clicking Next.

    Image typeamongmultiplespecies_fixedploidy
    Figure 13.59: Specify the parameters to be used for the Fixed Ploidy Variant Detection tool.

    The parameters that can be set are:

    • Required variant probability (%): The 'Required variant probability' is the minimum probability value of the 'variant site' required for the variant to be called. Note that it is not the minimum value of the probability of the individual variant. For the Fixed Ploidy Variant detector, if a variant site - and not the variant itself - passes the variant probability threshold, then the variant with the highest probability at that site will be reported even if the probability of that particular variant might be less than the threshold. For example if the required variant probability is set to 0.9 then the individual probability of the variant called might be less than 0.9 as long as the probability of the entire variant site is greater than 0.9.
    • Ignore positions with coverage above: Ignore positions with a read-coverage larger than this value.
    • Restrict calling to target regions: Select a region track to specify the regions in which variants should be called.
    • Ignore broken pairs: You can choose to ignore broken pairs by clicking this option.
    • Ignore non-specific matches: You can choose to ignore non-specific matches between reads, regions or to not ignore them at all.
    • Minimum read length: Only variants in reads longer than this size are called.
    • Minimum coverage: Only variants in regions covered by at least this many reads are called.
    • Minimum count: Only variants that are present in at least this many reads are called.
    • Minimum frequency %: Only variants that are present at least at the specified frequency (calculated as count/coverage) are called.
    • Base quality filter: The base quality filter can be used to ignore the reads whose nucleotide at the potential variant position is of dubious quality.
    • Neighborhood radius: Determine how far away from the current variant the quality assessment should extend.
    • Minimum central quality: Reads whose central base has a quality below the specified value will be ignored. This parameter does not apply to deletions since there is no "central base" in these cases.
    • Minimum neighborhood quality: Reads for which the minimum quality of the bases is below the specified value will be ignored.
    • Read direction filters: The read direction filter removes variants that are almost exclusively present in either forward or reverse reads.
    • Direction frequency %: Variants that are not supported by at least this frequency of reads from each direction are removed.
    • Relative read direction filter: The relative read direction filter attempts to do the same thing as the Read direction filter, but does this in a statistical, rather than absolute, sense: it tests whether the distribution among forward and reverse reads of the variant carrying reads is different from that of the total set of reads covering the site. The statistical, rather than absolute, approach makes the filter less stringent.
    • Significance %: Variants whose read direction distribution is significantly different from the expected with a test at this level, are removed. The lower you set the significance cut-off, the fewer variants will be filtered out.
    • Read position filter: It removes variants that are located differently in the reads carrying it than would be expected given the general location of the reads covering the variant site.
    • Significance %: Variants whose read position distribution is significantly different from the expected with a test at this level, are removed. The lower you set the significance cut-off, the fewer variants will be filtered out.
    • Remove pyro-error variants: This filter can be used to remove insertions and deletions in the reads that are likely to be due to pyro-like errors in homopolymer regions. There are two parameters that must be specified for this filter:
    • In homopolymer regions with minimum length: Only insertion or deletion variants in homopolymer regions of at least this length will be removed.
    • With frequency below: Only insertion or deletion variants whose frequency (ignoring all non-reference and non-homopolymer variant reads) is lower than this threshold will be removed.

  11. In the Result handling window, pressing the button Preview All Parameters allows you to preview - but not change - all parameters. Choose to save the results (we recommend to create a new folder to this effect) and click on the button labeled Finish.

Outputs are generated on a per sample basis and on a summary level. You can find them all in the new folder you created to save them (figure 13.60), but those marked with a (*) have also been added automatically to the New Metadata Result Table (see the section Example of results obtained using the Type a Known Species workflow to understand where your results have been saved).

Image typemultiplespeciesoutput
Figure 13.60: Output files from the Type Among Multiple Species workflow.

For each sample, the following outputs are generated:

For each batch analysis run, the following outputs are generated: