Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make function helptext more concise with a +bids/Contents.m #32

Merged
merged 1 commit into from
Dec 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion +bids/+util/tsvread.m
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
function x = tsvread(f,v,hdr)
% Load text and numeric data from file
% Load text and numeric data from tab-separated-value or other file
% FORMAT x = tsvread(f,v,hdr)
% f - filename (can be gzipped) {txt,mat,csv,tsv,json}
% v - name of field to return if data stored in a structure [default: '']
% or index of column if data stored as an array
% hdr - detect the presence of a header row for csv/tsv [default: true]
%
% x - corresponding data array or structure

%__________________________________________________________________________
%
% Based on spm_load.m from SPM12.
Expand Down
22 changes: 22 additions & 0 deletions +bids/Contents.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
% +BIDS - The bids-matlab library
%
% Contents
% layout - Parse a directory structure formated according to the BIDS standard
% query - Query a directory structure formated according to the BIDS standard
% report - Create a short summary of the acquisition parameters of a BIDS dataset
% validate - BIDS Validator
% util.jsondecode - Decode JSON-formatted file
% util.jsonencode - Encode JSON-formatted file
% util.tsvread - Load text and numeric data from tab-separated-value or other file
%
%__________________________________________________________________________
%
% BIDS (Brain Imaging Data Structure): https://bids.neuroimaging.io/
% The brain imaging data structure, a format for organizing and
% describing outputs of neuroimaging experiments.
% K. J. Gorgolewski et al, Scientific Data, 2016.
%__________________________________________________________________________
%
% BIDS-MATLAB is a library that aims at centralising MATLAB/Octave tools
% for interacting with datasets conforming to the BIDS format.
% See https://github.com/bids-standard/bids-matlab for more details.
4 changes: 4 additions & 0 deletions +bids/layout.m
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
% FORMAT BIDS = bids.layout(root)
% root - directory formated according to BIDS [Default: pwd]
% BIDS - structure containing the BIDS file layout
%
% See also:
% bids

%__________________________________________________________________________
%
% BIDS (Brain Imaging Data Structure): https://bids.neuroimaging.io/
Expand Down
4 changes: 4 additions & 0 deletions +bids/query.m
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
% query - type of query: {'data', 'metadata', 'sessions', 'subjects',
% 'runs', 'tasks', 'runs', 'types', 'modalities'}
% result - outcome of query
%
% See also:
% bids

%__________________________________________________________________________
%
% BIDS (Brain Imaging Data Structure): https://bids.neuroimaging.io/
Expand Down
4 changes: 4 additions & 0 deletions +bids/report.m
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ function report(BIDS, Subj, Ses, Run, ReadNII)
% Unless specified the function will only read the data from the first
% subject, session, and run (for each task of BOLD). This can be an issue
% if different subjects/sessions contain very different data.
%
% See also:
% bids

%__________________________________________________________________________
%
% BIDS (Brain Imaging Data Structure): https://bids.neuroimaging.io/
Expand Down
3 changes: 3 additions & 0 deletions +bids/validate.m
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
% Web version:
% https://bids-standard.github.io/bids-validator/
%__________________________________________________________________________
%
% See also:
% bids

% Copyright (C) 2018, Guillaume Flandin, Wellcome Centre for Human Neuroimaging
% Copyright (C) 2018--, BIDS-MATLAB developers
Expand Down