Package: bidsr 0.1.0

bidsr: A Brain Imaging Data Structure ('BIDS') Parser

Parse and read the files that comply with the brain imaging data structure, or 'BIDS' format, see the publication from Gorgolewski, K., Auer, T., Calhoun, V. et al. (2016) <doi:10.1038/sdata.2016.44>. Provides query functions to extract and check the 'BIDS' entity information (such as subject, session, task, etc.) from the file paths and suffixes according to the specification. The package is developed and used in the reproducible analysis and visualization of intracranial electroencephalography, or 'RAVE', see Magnotti, J. F., Wang, Z., and Beauchamp, M. S. (2020) <doi:10.1016/j.neuroimage.2020.117341>; see 'citation("bidsr")' for details and attributions.

Authors:Zhengjia Wang [aut, cre], Trustees of the University of Pennsylvania [cph]

bidsr_0.1.0.tar.gz
bidsr_0.1.0.zip(r-4.5)bidsr_0.1.0.zip(r-4.4)bidsr_0.1.0.zip(r-4.3)
bidsr_0.1.0.tgz(r-4.5-any)bidsr_0.1.0.tgz(r-4.4-any)bidsr_0.1.0.tgz(r-4.3-any)
bidsr_0.1.0.tar.gz(r-4.5-noble)bidsr_0.1.0.tar.gz(r-4.4-noble)
bidsr_0.1.0.tgz(r-4.4-emscripten)bidsr_0.1.0.tgz(r-4.3-emscripten)
bidsr.pdf |bidsr.html
bidsr/json (API)
NEWS

# Install 'bidsr' in R:
install.packages('bidsr', repos = c('https://dipterix.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/dipterix/bidsr/issues

Pkgdown site:https://dipterix.org

On CRAN:

Conda:

3.30 score 63 exports 16 dependencies

Last updated 13 hours agofrom:d9adbf3205. Checks:9 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKApr 01 2025
R-4.5-winOKApr 01 2025
R-4.5-macOKApr 01 2025
R-4.5-linuxOKApr 01 2025
R-4.4-winOKApr 01 2025
R-4.4-macOKApr 01 2025
R-4.4-linuxOKApr 01 2025
R-4.3-winOKApr 01 2025
R-4.3-macOKApr 01 2025

Exports:as_bids_tabularbids_projectbids_propertybids_property_characterbids_property_choicebids_property_collapsed_characterbids_property_data_framebids_property_deprecatedbids_property_entity_listbids_property_integerishbids_property_listbids_property_named_listbids_property_numericbids_property_optionalbids_property_prohibitedbids_property_recommendedbids_property_requiredbids_property_tabular_column_descriptor_listbids_property_tabular_contentbids_property_tabular_metabids_property_unnamed_listbids_subjectBIDSClassBaseBIDSDatasetDescriptionBIDSDatasetGeneratedByBIDSEntity_any_optionalBIDSEntity_any_prohibitedBIDSEntity_any_requiredBIDSEntity_index_optionalBIDSEntity_index_prohibitedBIDSEntity_index_requiredBIDSEntity_label_optionalBIDSEntity_label_prohibitedBIDSEntity_label_requiredBIDSMapBIDSProjectBIDSSubjectBIDSTabularBIDSTabularColumnDescriptorBIDSTabularMetaSidecarBIDSTabularParticipantsBIDSTabularPhenotypeBIDSTabularSamplesBIDSTabularScansBIDSTabularSessionsBIDSURIdownload_bids_examplesget_bids_dataset_descriptionget_bids_entityget_bids_entity_rulesget_bids_participantsget_bids_phenotype_dataget_bids_samplesnew_bids_classnew_bids_entity_file_classnew_bids_tabular_classparse_path_bids_entityquery_bidsresolve_bids_pathsave_bids_tabularsave_bids_tabular_defaultset_propsvalid_eventually

Dependencies:backportsbitbit64checkmatedata.tablefastmapfsjsonlitelatticenanotimeRcppRcppCCTZRcppDateS7uuidzoo

Get Started

Rendered fromaaa-get-started.Rmdusingknitr::rmarkdownon Apr 01 2025.

Last update: 2025-03-29
Started: 2025-03-26

Readme and manuals

Help Manual

Help pageTopics
Class definitions and utilities for 'BIDS' tabularas_bids_tabular BIDSTabular BIDSTabularColumnDescriptor BIDSTabularMetaSidecar new_bids_tabular_class save_bids_tabular save_bids_tabular_default
'BIDS' project classBIDSProject bids_project
''S7'' property for 'BIDS' classesbids_property bids_property_character bids_property_choice bids_property_collapsed_character bids_property_data_frame bids_property_deprecated bids_property_entity_list bids_property_integerish bids_property_list bids_property_named_list bids_property_numeric bids_property_optional bids_property_prohibited bids_property_recommended bids_property_required bids_property_tabular_column_descriptor_list bids_property_tabular_content bids_property_tabular_meta bids_property_unnamed_list
'BIDS' subject classBIDSSubject bids_subject
Low-level abstract class for 'bidsr'BIDSClassBase
Class definition for 'BIDS' meta-data ''GeneratedBy''BIDSDatasetGeneratedBy
Class definitions of 'BIDS' entityBIDSEntity BIDSEntity_any_optional BIDSEntity_any_prohibited BIDSEntity_any_required BIDSEntity_index_optional BIDSEntity_index_prohibited BIDSEntity_index_required BIDSEntity_label_optional BIDSEntity_label_prohibited BIDSEntity_label_required
Low-level nested map to store key-value data with inherited structureBIDSMap
'BIDS' scans table classBIDSTabularScans
'BIDS' sessions table classBIDSTabularSessions
'BIDS' uniform resource indicator ('URI') class definitionBIDSURI
Download 'BIDS' example data-setsdownload_bids_examples
Class definition of 'BIDS' data-set descriptionBIDSDatasetDescription get_bids_dataset_description
Get 'BIDS' entity values from fileget_bids_entity get_bids_entity_rules
'BIDS' participant table classBIDSTabularParticipants get_bids_participants
'BIDS' phenotype and assessment table classBIDSTabularPhenotype get_bids_phenotype_data
'BIDS' samples table classBIDSTabularSamples get_bids_samples
Create new 'bidsr' class definitionnew_bids_class
Class generator for 'BIDS' file class with entitiesnew_bids_entity_file_class
Parse 'BIDS' entities from file pathparse_path_bids_entity
Query 'BIDS'query_bids
Resolve path of a 'BIDS' objectresolve_bids_path