Goby/Align

From Icbwiki

Jump to: navigation, search

This mode is used to run third party aligners, taking care of data translations. Data translations include converting compact reads to the aligner input and converting the aligner output to compact alignment format. It is implemented by edu.cornell.med.icb.goby.modes.AlignMode.java.

Mode Parameters

The following options are available in this mode

Flag Arguments Required Description
(-r|--reads) reads no Name of the compact reads input file. Required to --search.
(-d|--reference) reference yes Name of the compact reads reference file, or path to the formatted database previously produced with the --index option.
(-f|--read-index-filter) read-index-filter no The name of a read index filter. When provided, the aligner will only be provided with the reads that are included in the filter.
(-g|--reference-index-filter) reference-index-filter no The name of a reference index filter. When provided, the aligner will only search references whose indices are included in the filter.
--work-directory work-directory no The work directory.
--database-directory database-directory no The database directory.
--database-name database-name no The database name.
--search search yes When this switch is provided, search the reads against the reference.
--index index yes When this switch is provided, index the reference. Name the indexed reference according to the output basename. Indexing is done as part of search when it is required by the aligner, but this option is provided to build an aligner index independently from a search.
--get-default-database-name get-default-database-name yes When this switch is provided, the default database name for the specified --reference file will be returned on stdout.
(-a|--aligner) aligner yes Name of the third-party aligner to align with.
(-o|--options) options no Aligner specific options. Specifying "--options m=3,k=2" will pass the string "-m 3 -k 2" to the aligner. Supports any options that are supported by the aligner.
--color-space color-space yes When this switch is provided, convert the sequence to color mode. Only makes sense if the compact file encodes a sequence in fasta format.
(-p|--quality-filter-parameters) quality-filter-parameters yes Parameters to configure the quality filter. ["quality-filter-parameters" and "ambiguity-threshold" may eventually be condensed into "filterOptions"]
--ambiguity-threshold ambiguity-threshold no Maximum number of locations that a read can match to be included in the alignment entries. ["quality-filter-parameters" and "ambiguity-threshold" may eventually be condensed into "filterOptions"]
--keep-temporary-files keep-temporary-files no When this switch is provided, keep temporary files created during the alignment. These files typically hold the result of the alignment in the native aligner format.
(-b|--basename) basename no Basename of the alignment to output.
Personal tools