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

Doc: Typo fixes in comments and helptext #38

Merged
merged 1 commit into from
Dec 31, 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
6 changes: 3 additions & 3 deletions +bids/layout.m
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function BIDS = layout(root)
% Parse a directory structure formated according to the BIDS standard
% Parse a directory structure formatted according to the BIDS standard
% FORMAT BIDS = bids.layout(root)
% root - directory formated according to BIDS [Default: pwd]
% root - directory formatted according to BIDS [Default: pwd]
% BIDS - structure containing the BIDS file layout
%
% See also:
Expand Down Expand Up @@ -132,7 +132,7 @@
%==========================================================================
function subject = parse_subject(p, subjname, sesname)
% For each modality (anat, func, eeg...) all the files from the
% corresponding directory are listed and their filename parsed with extra
% corresponding directory are listed and their filenames parsed with extra
% BIDS valid entities listed (e.g. 'acq','ce','rec','fa'...).

subject.name = subjname; % subject name ('sub-<participant_label>')
Expand Down
2 changes: 1 addition & 1 deletion +bids/private/parse_filename.m
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

filename = file_utils(filename,'filename');

%-Identify all the BIDS entitiy-label pairs present in the filename (delimited by "_")
%-Identify all the BIDS entity-label pairs present in the filename (delimited by "_")
% https://bids-specification.readthedocs.io/en/stable/99-appendices/04-entity-table.html
[parts, dummy] = regexp(filename,'(?:_)+','split','match');
p.filename = filename;
Expand Down
6 changes: 3 additions & 3 deletions +bids/report.m
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ function report(BIDS, Subj, Ses, Run, ReadNII)
% FORMAT bids.report(BIDS, Subj, Ses, Run, ReadNII)
%
% INPUTS:
% - BIDS: directory formated according to BIDS [Default: pwd]
% - BIDS: directory formatted according to BIDS [Default: pwd]
%
% - Subj: Specifies which subject(s) to take as template.
% - Ses: Specifies which session(s) to take as template. Can be a vector.
Expand Down Expand Up @@ -36,7 +36,7 @@ function report(BIDS, Subj, Ses, Run, ReadNII)
% - deal with DWI bval/bvec values not read by bids.query
% - write output to a txt file?
% - deal with "EEG" / "MEG"
% - deal wiht "events": compute some summary statistics as suggested in
% - deal with "events": compute some summary statistics as suggested in
% COBIDAS report
% - report summary statistics on participants as suggested in COBIDAS report
% - check if all subjects have the same content?
Expand Down Expand Up @@ -249,7 +249,7 @@ function report(BIDS, Subj, Ses, Run, ReadNII)
'dwi', '', '', ReadNII);

% dirty hack to try to look into the BIDS structure as bids.query does not
% support querying directly for bval anb bvec
% support querying directly for bval and bvec
try
acq_param.n_vecs = num2str(size(BIDS.subjects(Subj).dwi.bval,2));
% acq_param.bval_str = ???
Expand Down
2 changes: 1 addition & 1 deletion +bids/validate.m
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function [sts, msg] = validate(root)
% BIDS Validator
% FORMAT [sts, msg] = bids.validate(root)
% root - directory formated according to BIDS [Default: pwd]
% root - directory formatted according to BIDS [Default: pwd]
% sts - 0 if successful
% msg - warning and error messages
%__________________________________________________________________________
Expand Down