selex.config {SELEX} | R Documentation

## Set SELEX system parameters

### Description

A function used to set system parameters for the SELEX package. These parameters are stored as global options, which are checked at runtime. They can be permanently set in a .Rprofile file, or changed temporarily by the user by invoking `selex.config`. It is important to set `java.parameters` before loading the SELEX library. See ‘Details’ for more information.

### Usage

    selex.config(workingDir=NULL, verbose=NULL, maxThreadNumber=NULL)

### Arguments

`workingDir` | Physical location on disk for the current working directory. The full system path must be specified.
`verbose` | Print more output to terminal. Useful for debugging.
`maxThreadNumber` | The maximum number of threads to be used while K-mer counting. If unspecified, 4 threads will be used.

### Details

The working directory is used to store the output of all analyses performed by the selex package. If a certain calculation has already been performed in the given working directory, the previously computed values are returned. If the specified path does not exist, `selex.config` will attempt to create it. By default, a temporary directory is used.
It is important to set the Java memory options before loading the SELEX library to allocate enough memory to the JVM. You can allocate memory by calling `options` and setting `java.parameters`. `-Xmx` must prefix the memory value; the code below allocates 1500 MB of RAM:
`options(java.parameters="-Xmx1500M")`
If the memory option is unspecified, the default JVM memory setting will be used.

### Value

Not applicable

### See Also

`selex.jvmStatus`, `selex.setwd`

### Examples

    ## Initialize SELEX
    #options(java.parameters="-Xmx1500M")
    #library(SELEX)

    ## Set working directory and verbose to true
    workDir = file.path(".", "SELEX_workspace")
    selex.config(workingDir=workDir,verbose=TRUE, maxThreadNumber=4)

[Package SELEX version 1.22.0 Index]