Skip to content

circadia-bio/boldR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🧲 boldR

fmriprep gets you clean data. boldR gets you useful data.

R CMD CHECK License: MIT


⚠️ boldR is in early development and has not been formally tested. The API may change without notice, estimation results have not yet been validated against a reference implementation, and the package has not undergone peer review. Use with caution and verify outputs independently before using in any research context.


boldR is an R package for analysing Blood-Oxygen-Level-Dependent (BOLD) fMRI data in the context of sleep and circadian research. It picks up exactly where fMRIPrep leaves off β€” working directly with preprocessed BIDS derivatives β€” and transforms them into analysis-ready outputs.

boldR is part of the Circadia Lab R ecosystem at Northumbria University.


Key features

  • fMRIPrep as the input standard β€” reads preprocessed BIDS derivatives directly; no custom preprocessing required.
  • Atlas-agnostic parcellation β€” built-in support for common atlases (Schaefer, AAL); custom atlases accepted via a simple boldR_atlas schema.
  • Voxelwise metrics β€” temporal SNR, voxelwise GLM contrasts.
  • ROI-level outputs β€” timeseries extraction, functional connectivity matrices, summary metrics per ROI.
  • syncR-ready export β€” parcellated BOLD data flows directly into syncR::sync() alongside actigraphy, PSG, and questionnaire data.

Installation

# Install from GitHub (development version)
# install.packages("pak")
pak::pak("circadia-bio/boldR")

Ecosystem

fmriprep β†’ boldR ──────────────────→ syncR
                 └─→ (parcellated)

boldR is designed to be used alongside:

Package Role
zeitR Actigraphy & circadian metrics
mrpheus PSG signal analysis
hypnor Hypnogram handling & sleep architecture
slumbR Sleep diary processing
syncR Unified participant database

Authors


License

MIT Β© 2026 Lucas FranΓ§a, Mario Leocadio-Miguel

About

🧠 boldR gets you useful data.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages