R: Sets/gets the number of threads to use in 'fixest' functions

setFixest_nthreads {fixest} | R Documentation

## Sets/gets the number of threads to use in `fixest` functions

### Description

Sets/gets the default number of threads to used in `fixest` estimation functions. The default is the maximum number of threads minus two.

### Usage

    setFixest_nthreads(nthreads)

    getFixest_nthreads

### Arguments

`nthreads` | The number of threads. Can be: a) an integer lower than, or equal to, the maximum number of threads; b) 0: meaning all available threads will be used; c) a number strictly between 0 and 1 which represents the fraction of all threads to use. If missing, the default is to use 50% of all threads.

### Format

An object of class `function` of length 1.

### Author(s)

Laurent Berge

### Examples

    # Gets the current number of threads
    getFixest_nthreads()

    # To set multi-threading off:
    setFixest_nthreads(1)

    # To set it back to default:
    setFixest_nthreads()

[Package fixest version 0.8.4 Index]