brainGraph: Default options for brainGraph

In cwatson/brainGraph: Graph Theory Analysis of Brain MRI Data

Default options for brainGraph

Description

brainGraph is a package for performing graph theory analysis of brain MRI data.

Package options

brainGraph uses the following options to configure behavior:

• bg.subject_id: character string specifying the name your project/study uses as a subject identifier. All imported data (e.g., covariates tables) MUST have a column matching this. One possible alternative is 'participant_id', recommended by BIDS. Default: 'Study.ID'

• bg.group: character string specifying the name your project/study uses as a group identifier. All imported data (e.g., covariates tables) MUST have a column matching this. One possible alternative is 'group', recommended by BIDS. Default: 'Group'

• bg.session: character string specifying the name your project/study uses as a “time” or session identifier, in the case of longitudinal studies. All imported data (e.g., covariates tables) MUST have a column matching this. One possible alternative is 'session_id', recommended by BIDS. Default: 'Time'

• bg.progress: logical indicating whether to show progress bars for functions that provide the option. Default: TRUE

• bg.ncpus: integer indicating the number of cores to use for parallel operations. Only used if you have not already registered a parallel backend (see Chapter 5 of the User Guide or https://github.com/cwatson/brainGraph/blob/master/README.md for examples). Default: 2L

cwatson/brainGraph documentation built on Feb. 21, 2024, 6:33 p.m.