set_rsyntax_threads {rsyntax}

Set number of threads to be used by rsyntax functions

Description

rsyntax relies heavily on the data.table package, which supports multithreading. By default, the number of threads set by data.table are used, as you can see with getDTthreads. Here you can set the number of threads for rsyntax functions, without affecting the data.table settings.

Usage

set_rsyntax_threads(threads = NULL)

Arguments

threads

The number of threads to use. Cannot be higher than number of threads used by data.table, which you can change with setDTthreads. If left empty (NULL), all data.table threads are used

Value

Does not return a value. Sets the global 'rsyntax_threads' option.

Examples

current_threads = rsyntax_threads()

set_rsyntax_threads(2)

## undo change (necessary for CRAN checks)
set_rsyntax_threads(current_threads)