tedana.metrics.external.load_validate_external_regressors

load_validate_external_regressors(*, external_regressors: str, external_regressor_config: Dict, n_vols: int, dummy_scans: int) → Tuple[DataFrame, Dict]

Load and validate external regressors and descriptors in dictionary.

Parameters:

• external_regressors (str) – Path and name of tsv file that includes external regressor time series

• external_regressor_config (dict) – A dictionary with info for fitting external regressors to component time series

• n_vols (int) – Number of timepoints in the fMRI time series.

• dummy_scans (int) – Number of dummy scans in the fMRI time series.

Returns:

• external_regressors (pandas.DataFrame) – Each column is a labelled regressor and the number of rows should match the number of timepoints in the fMRI time series

• external_regressor_config (dict) – A validated dictionary with info for fitting external regressors to component time series. If regex patterns like ‘^mot_.*$’ are used to define regressor names, this is replaced with a list of the match column names used in external_regressors