SaveBWASfile: SaveBWASfile - A Modularlized function for MarginalModelCifti...

In DCAN-Labs/MarginalModelCIFTI: MarginalModelCifti constructs and tests marginal models for surface and volume data.

Description

This function saves stat map data for ConstructMarginalModel. Created to further modularlize the R package.

Usage

SaveBWASfile(
  BWAS_statmap,
  structtype,
  output_prefix,
  measnames,
  surf_command = NULL,
  surf_template_file = NULL,
  wb_command = NULL,
  zeros_array = NULL,
  matlab_path = NULL,
  sigtype = "NULL",
  output_directory = "./"
)

Arguments

BWAS_statmap	A matrix containing a brain-wide assocation statistical map, can be anything as long as it matches the dimensions of the inputs
structtype	A character string denoting whether the map is volumetric ('volume'), surface-based ('surface'), a pconn ('pconn'), or a NIFTI connectivity matrix ('niiconn').
output_prefix	A character string depicting the prefix of the output filenames, usually depicting the map metric
measnames	A list of measures (covariates) being tested by the model, used to label the maps appropriately.
surf_command	A path to the SurfConnectivity toolbox used to perform CIFTI/GIFTI writing
surf_template_file	A path to a surface template file to use for CIFTI/GIFTI writing
wb_command	A full path/filename to thte wb_command file, used for ciftis
zeros_array	A 2D array filled with zeros representing the initial structure for pconns and niicons, used to speed up file-saving
matlab_path	A full path/filename to the matlab runtime compiler engine, must be V91
sigtype	A character string denoting whether the map is volumetric ('volume'), surface-based ('surface'), a pconn ('pconn'), or a NIFTI connectivity matrix ('niiconn').
output_directory	A character string denoting the full path to the output directory for the file

Examples

SaveBWASfile(BWAS_statmap,structtype,output_prefix,measnames)

DCAN-Labs/MarginalModelCIFTI documentation built on Nov. 30, 2021, 3:40 p.m.