parameters {rTANDEM} | R Documentation

## Creates and manipulates parameter objects for rTANDEM

### Description

Those functions instantiate parameter objects for rTANDEM and manipulate their values. Many of those functions give default values, either for general settings (e.g. setParamDefault), for instrument specific settings (e.g. setParamOrbitrap), or for function specific settings (e.g. setParamPTMTreeSearch).

### Usage

    rTParam()
    setParamValue(param, category, parameter=NULL, value)
    setParamDefault(param=NULL)
    setParamPTMTreeSearch(param=NULL)
    setParamOrbitrap(param=NULL)
    setParamIonTrap(param=NULL)
    setParamQuadTof05da(param=NULL)
    setParamQuadTof100ppm(param=NULL)
    rTTaxo(taxon=NA, format=NA, URL=NA)
    addTaxon(taxonomy=NULL, taxon, format="peptide", URL)
    ## S3 method for class 'rTParam'
    print(x, ...)

### Arguments

`param` | A parameter object of class rTParam.
`x` | A parameter object of class rTParam.
`...` | Further arguments passed to or from other methods.
`category` | A string representing a category of parameters (e.g. "output", "protein").
`parameter` | A string representing the name of a parameter.
`value` | The value to give to the parameter.
`taxon` | A string representing the name of a taxon (e.g. "homo sapiens").
`taxonomy` | A taxonomy object of class rTTaxo.
`format` | A string representing the type of the database. The four types are: "peptide", "saps", "mods" and "spectrum".
`URL` | A string representing the full path to the database file.

### Value

The functions rTParam, and all functions setParam..., return an object of S3 class rTParam. The functions rTTaxo and addTaxon return an object of S3 class rTTaxo. print.rTParam is used for its side effect of displaying a parameter object.

### References

thegpm.org/TANDEM/api/

### See Also

`GetParamFromXML`, `GetTaxoFromXML`, `WriteTaxoToXML`, `WriteParamToXML`.

### Examples

    # Initialize an empty parameter object:
    param <- rTParam()
    print.rTParam(param)

    # Set general values.
    param <- setParamDefault(param)

    # Add instrument specific values for a LTQ mass spectrometer.
    param <- setParamIonTrap(param)
    print.rTParam(param)

[Package rTANDEM version 1.26.0 Index]