Man pages for UNCDEPENdLab/fmri.pipeline
Analysis of fMRI Data on HPC clusters

add_baseline_regressorsHelper function to append baseline regressors to the...
add_custom_feat_syntaxHelper function to find/replace or insert additional...
add_tracked_job_parentAdd parent/child id relationship to tracking database
afni_3dclusterizewrapper class for 3dClusterize
afni_3dclustsimR6 class for 3dClustSim automation
afni_3dclustsim_listR6 class for a list of 3dClustSim runs
afni_3dfwhmxR6 class for running 3dFWHMx on a single input file based on...
afni_3dfwhmx_listR6 class for running 3dFWHMx on a group of input files using...
afni_whereamiwrapper class for AFNI whereami
as.character.formulaS3 method to convert formula to character
as_dhmshelper function to convert a period object back into a...
bl1_build_eventshelper function to build events consisting of onsets and...
bl1_build_modelshelper function to create a set of level 1 models
bl1_build_signalshelper function to build level 1 signals
bl1_get_colsOnset, duration, value column selection helper function
build_3dclustsim_permutationhelper function for setting up 3dClustSim objects for...
build_beta_extractionhelper function to prompt user to choose combinations of l1,...
build_design_matrixCreates an fmri design matrix, including timing files for for...
build_fwe_correctionFunction to walk user through setting up FWE corrections for...
build_l1_modelsInteractive function to build an l1 model specification for...
build_l2_modelsInteractive function to build an l2 model specification for...
build_l3_modelsInteractive function to build an l3 model specification for...
calculate_subject_exclusionssmall helper function to populate subject exclusions in...
check_numshelper function to validate numbers in an input string or...
choose_glm_modelshelper function to ask user to choose models at a given level...
choose_glm_sethelper function to guide user through process of choosing...
cleanup_glm_pipelinehelper function to refresh l3 model status and save gpa...
cleanup_regressorSmall utility function to handle any NAs in the regressor...
cluster_job_submitThis function submits a single script to a high-performance...
cluster_submit_shell_jobshelper function to submit a set of shell jobs that are...
combine_feat_l3_to_afniFunction to combine Feat L3 analyses into AFNI BRIK+HEAD...
compress_mts_pcaCore function for computing multivariate time series...
compute_spike_regressorscompute spike regressors from a data.frame or matrix of...
concat_design_runsConcatenate design matrices for each run to form a single...
convolve_cppInternal function to convolve two vectors using nested for...
convolve_dcv_hrfThis function takes in a matrix of generated neural events...
convolve_double_gammaThis function convolves a stimulus vector with the...
convolve_regressorThis function convolves a regressor with a normalized HRF...
create_fwe_spechelper function to create an FWE object that specifies the...
create_new_hi_modelInternal function to walk through l2/l3 model setup,...
create_tracking_dbInternal helper function to create the tracking SQLite...
deconvolve_nlregC++ port of Bush and Cisler 2013, Magnetic Resonance Imaging...
deconvolve_nlreg_resampleThis function deconvolves the BOLD signal using Bush 2011...
detrendtsDetrend a time series up to quadratic trend. Used by...
dhmssmall helper function to parse duration syntax of...
do_convolveInternal port of fsl do_convolve
dsigmoidDsigmoid transform
enforce_glms_completeHelper function to create named data.frame from a set of...
event_lock_tsfunction to get interpolated event locked data
evt_align_decon_filesAlign a set of deconvolved time series files to an event of...
export_glm_configOutput GLM configuration to a '.yaml' or 'json' file
extract_bids_infoFunction for extracting fields from BIDS filenames (mostly...
extract_fsl_betasfunction to extract voxelwise betas from a given level of FSL...
extract_glm_betas_in_maskFunction to extract subject-level coefficients from an FSL...
feat_stats_to_brikinternal function to convert a feat level 1 directory to an...
fields_from_specinternal function to populate l1_model_set onsets from spec...
file_extinternal function for getting a file extension that may...
file_sans_extinternal function for returning a file (and path) without its...
fill_atlas_with_statsPopulates parcel-wise statistics from an atlas or set of...
finalize_confound_settingsHelper function to populate confound information for pipeline...
finalize_pipeline_configurationThis is a small helper function to validate the...
fir1BandpassApply a FIR-1 bandpass filter a signal. Can low- or high-pass...
fmri.designfmri.design function from 'fmri' R package. Brought into this...
fmri.pipeline-packagefmri.pipeline: Analysis of fMRI Data on HPC clusters
fmri.stimulusConvolve a regressor with a hemodynamic response function for...
fmri_tsR6 class representing a multivariate time series object for...
fsl_generate_fsf_contrast_syntaxThis function generates syntax for FSL Feat .fsf files for...
fsl_generate_fsf_ev_syntaxThis function generates syntax for FSL Feat .fsf files for...
fsl_generate_fsf_lvl1_ev_syntaxThis function generates syntax for FSL Feat .fsf files for...
fsl_l1_modelThis function specifies a first-level GLM model in FSL based...
fsl_l2_modelEstimate a level 2 (subject) model using FSL FEAT with fixed...
fsl_l3_modelEstimate a level 2 (subject) model using FSL FEAT with fixed...
fwe_specR6 class for an FWE correction method that can apply to one...
generate_featureThis function creates K shifts of a neural events vector...
generate_feature_armadilloThis function creates K shifts of a neural events vector...
generate_mask_diagnosticsGenerate a set of diagnostic images and plots for brain masks...
generate_motion_regressorshelper function for generating motion regressors from raw...
generate_run_data_from_bidsFunction to generate a run_data object from a BIDS-compliant...
generate_subject_data_from_bidsFunction to generate a subject_data object from a...
generate_trial_data_from_bidsFunction to generate a trial_data object from a...
get_collin_eventsSmall helper function to calculate collinearity diagnostics...
get_contrasts_from_spechelper function to generate a contrast matrix from an lm()...
get_feat_statushelper function to look at whether feat ingredients exist for...
get_l1_configFunction to output l1_models into '.yaml' object
get_l1_confoundshelper function to generate confounds txt file for inclusion...
get_l2_configHelper function to output l2_models into '.yaml' object
get_l3_configGet a list containing configuration settings for l3 models
get_medusa_compression_scorefront-end function for taking a list of windowed time series...
get_medusa_interpolated_tsfront-end function for taking a list of windowed time series...
get_mr_abspathsmall helper function to pull absolute paths to a given...
get_output_directorysmall helper function to return the location of an l1...
get_tracked_job_statusQuery job status in tracking SQLite database
hours_to_dhmsconvert a number of hours to a days, hours, minutes, seconds...
insert_df_sqlitehelper function to insert a keyed data.frame into the sqlite...
insert_tracked_jobInternal helper funciton to insert a job into the tracking...
interpolate_fmri_epochsInterpolate an aligned fmri_ts object onto a consistent time...
lookup_dimHelper function to obtain the dimensions of a 4D file
lookup_nifti_inputshelper function to locate nifti inputs for each run of data
lookup_nvoxelsHelper function to obtain the number of voxels in a 4D file...
lookup_run_volumesHelper function to obtain the number of volumes in a 4D nifti...
meta_mixed_byFunction to run Bayesian random-effects meta-regression on...
mixed_byMixed by runs a set of mixed-effects models for each...
mobj_fit_lminternal helper function to setup a linear model for a given...
mobj_refit_lmHelper function to re-calculate the l3 design matrix for a...
names_to_internalhelper function to rename columns of input data.frame to...
ol_mean_min_maxRound and format the mean, min, and max as a single character...
ol_uniquePrint the top n unique values and frequencies of an atomic...
path_sanitizeSanitize a filename by removing directory paths and invalid...
pca_motionsmall helper function for compressing motion parameters using...
place_dmat_on_time_gridFunction to convert dmat (runs x regressor list) to a...
populate_defaultshelper function to copy any missing fields in target
populate_last_eventsInternal function to add last_onset and last_offset columns...
ptfce_specR6 class for pTFCE specification for one or more z-statistic...
R_batch_jobDescription of R_batch_job R6 class
R_batch_sequenceDescription of R_batch_sequence R6 class
read_df_sqlitehelper function to lookup a keyed data.frame from the sqlite...
read_feat_dirhelper function to look up core stats outputs from a .feat...
read_feat_inputsThis is a small helper function that returns the inputs...
read_gfeat_dirhelper function to look up core stats outputs from a .gfeat...
refresh_feat_statussmall helper function to look at feat outputs and files to...
reset_tracking_sqlite_dbInternal helper function to reset tracking SQLite database
respecify_l2_models_by_subjectHelper function to run the requested GLM model for each...
rle_dtR6 class for a keyed data.table object that uses run-length...
run_afni_commandWrapper for running an AFNI command safely within R
run_decon_alignmentAlign a set of deconvolved time series files from...
run_feat_sepjobsfunction to submit a set of jobs on a cluster to estimate...
run_fsl_commandWrapper for running an FSL command safely within R
run_glm_pipelineprimary function for running a GLM analysis pipeline
runmeancompute a moving average smooth over a time series (here, a...
sched_args_to_headerhelper function to convert the $sched_args field to a vector...
setdiff_list_combninternal function to print bidirectional set differences in a...
setup_compute_environmentHelper function for setting up and modifying the compute...
setup_glm_pipelineMain worker function for setting up an analysis pipeline
setup_l1_modelsFunction for setting up level 1 model specifications and...
setup_l2_modelsThis function generates the inputs for an FSL level 2...
setup_l3_modelsThis function generates the inputs for level 3 analyses,...
sigmoidSigmoid transform
simulate_null_3dttesthelper class to generate 3dttest++ null datasets using...
specify_contrastsInternal function to add, edit, rename, delete contrasts
submit_sqlite_queryhelper function to establish sqlite connection and submit...
submit_tracking_queryInternal helper function to submit a query to the tracking...
summarize_contrastsInternal helper function for printing a summary of a contrast...
summary.bg_block_dataSummarize the contents of the subject data
summary.bg_subject_dataSummarize the contents of the subject data
summary.glm_pipeline_argumentsHelper function to better summarize GPA object
summary.l1_model_setHelper function to better summarize GPA object's L1 models
summary.l1_model_set_eventsHelper function to better summarize GPA object's l1_models'...
summary.l1_model_set_modelsHelper function to better summarize GPA object's l1_models'...
summary.l1_model_set_signalsHelper function to better summarize GPA object's l1_models'...
truncate_runsIdentify the last valid volume acquired in a given run....
update_dfthis helper function replaces matching rows of a current...
update_tracked_job_statusUpdate job status in tracking SQLite database
validate_block_datainternal function to validate the contents of a block...
validate_dhmshelper function to validate format of walltime inputs for HPC...
validate_input_datahelper function to verify contents of subject, run, block,...
visualize_design_matrixVisualize design matrix, including event onset times and run...
voxelwise_deconvolutionFunction to perform voxelwise deconvolution on an fMRI...
wait_for_jobThis function pauses execution of an R script while a...
UNCDEPENdLab/fmri.pipeline documentation built on April 3, 2025, 3:21 p.m.