msaClustalW {msa} | R Documentation

## Multiple Sequence Alignment with ClustalW

### Description

This function calls the multiple sequence alignment algorithm ClustalW.

### Usage

        msaClustalW(inputSeqs, cluster="default", gapOpening="default",
                    gapExtension="default", maxiters="default",
                    substitutionMatrix="default", type="default",
                    order=c("aligned", "input"), verbose=FALSE,
                    help=FALSE, ...)

### Arguments

`inputSeqs` | input sequences; see `msa`. In the original ClustalW implementation, this parameter is called `infile`.
`cluster` | The clustering method which should be used. Possible values are `"nj"` (default) and `"upgma"`. In the original ClustalW implementation, this parameter is called `clustering`. Please note that `cluster="upgma"` leads to an unidentified error on Windows with R 4.0.x that even crashes the entire R session.
`gapOpening` | gap opening penalty; the default value for nucleotide sequences is 15.0, the default value for amino acid sequences is 10.0.
`gapExtension` | gap extension penalty; the default value for nucleotide sequences is 6.66, the default value for amino acid sequences is 0.2.
`maxiters` | maximum number of iterations; the default value is 16. In the original ClustalW implementation, this parameter is called `numiters`.
`substitutionMatrix` | substitution matrix for scoring matches and mismatches; can be a real matrix, a file name, or the name of a built-in substitution matrix. In the latter case, the choices `"blosum"`, `"pam"`, `"gonnet"`, and `"id"` are supported for amino acid sequences. For aligning nucleotide sequences, the choices `"iub"` and `"clustalw"` are possible. The parameter `dnamatrix` can also be used instead for the sake of backwards compatibility. The valid choices for this parameter are `"iub"` and `"clustalw"`. In the original ClustalW implementation, this parameter is called `matrix`.
`type` | type of the input sequences `inputSeqs`; see `msa`.
`order` | how the sequences should be ordered in the output object (see `msa`); in the original ClustalW implementation, this parameter is called `outorder`.
`verbose` | if `TRUE`, the algorithm displays detailed information and progress messages.
`help` | if `TRUE`, information about algorithm-specific parameters is displayed. In this case, no multiple sequence alignment is performed and the function quits after displaying the additional help information.
`...` | further parameters specific to ClustalW; An overview of parameters that are available in this interface is shown when calling `msaClustalW` with `help=TRUE`. For more details, see also the documentation of ClustalW.

### Details

This is a function providing the ClustalW multiple alignment algorithm as an R function. It can be used for various types of sequence data (see `inputSeqs` argument above). Parameters that are common to all multiple sequences alignments provided by the msa package are explicitly provided by the function and named in the same for all algorithms. Most other parameters that are specific to ClustalW can be passed to ClustalW via additional arguments (see argument `help` above).

For a note on the order of output sequences and direct reading from FASTA files, see `msa`.

### Value

Depending on the type of sequences for which it was called, `msaClustalW` returns a `MsaAAMultipleAlignment`, `MsaDNAMultipleAlignment`, or `MsaRNAMultipleAlignment` object. If called with `help=TRUE`, `msaClustalW` returns an invisible `NULL`.

### Author(s)

Enrico Bonatesta and Christoph Horejs-Kainrath <msa@bioinf.jku.at>

### References

http://www.bioinf.jku.at/software/msa

U. Bodenhofer, E. Bonatesta, C. Horejs-Kainrath, and S. Hochreiter (2015). msa: an R package for multiple sequence alignment. Bioinformatics 31(24):3997-3999. DOI: 10.1093/bioinformatics/btv494.

http://www.clustal.org/download/clustalw_help.txt

Thompson, J. D., Higgins, D. G., and Gibson, T. J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple sequence alignment through sequence weighting, position-specific gap penalties and weight matrix choice. Nucleic Acids Res. 22(22):4673-4680. DOI: 10.1093/nar/22.22.4673.

### See Also

`msa`, `MsaAAMultipleAlignment`, `MsaDNAMultipleAlignment`, `MsaRNAMultipleAlignment`, `MsaMetaData`

### Examples

    ## read sequences
    filepath <- system.file("examples", "exampleAA.fasta", package="msa")
    mySeqs <- readAAStringSet(filepath)

    ## call msaClustalW with default values
    msaClustalW(mySeqs)

    ## call msaClustalW with custom parameters
    msaClustalW(mySeqs, gapOpening=1, gapExtension=1, maxiters=16,
                kimura=FALSE, order="input", maxdiv=23)

[Package msa version 1.24.0 Index]