Skip to content

Commit 1ebaee6

Browse files
Remi-GauRemi-Gau
committed
add template to help section to all other functions
1 parent 1ad6439 commit 1ebaee6

17 files changed

+323
-0
lines changed

‎src/checkCFG.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function cfg = checkCFG(cfg)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423
% cfg = checkCFG(cfg)
524
%
625
% check that we have all the fields that we need in the experiment parameters

‎src/convertSourceToRaw.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function convertSourceToRaw(cfg)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423
% convertSourceToRaw(cfg)
524
%
625
% attempts to convert a source dataset created with CPP_BIDS into a valid

‎src/createDataDictionary.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function createDataDictionary(cfg, logFile)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423
% createDataDictionary(cfg, logFile)
524
%
625
% creates the data dictionary to be associated with a _events.tsv file

‎src/createDatasetDescription.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function createDatasetDescription(cfg)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423
% createDatasetDescription(cfg)
524
%
625
% creates the datasetDescription.json file that goes in the root of a BIDS

‎src/gui/askForGroupAndOrSession.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function cfg = askForGroupAndOrSession(cfg)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423

524
askGrpSess = [true true];
625

‎src/gui/askUserCli.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function responses = askUserCli(questions, responses)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423
% response = askUserCli(questions)
524
%
625
% command line interface to ask questions to user

‎src/gui/askUserGui.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function responses = askUserGui(questions, responses)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423

524
% boolean for which question should be asked
625
isQuestionToAsk = ~cellfun('isempty', questions.questionsToAsk(:, 1));

‎src/gui/createQuestionList.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function questions = createQuestionList(cfg)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423

524
cfg = askForGroupAndOrSession(cfg);
625

‎src/gui/getIsQuestionToAsk.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function isQuestionToAsk = getIsQuestionToAsk(questions, responses)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423

524
isQuestionToAsk = cell2mat(questions.questionsToAsk(:, 2));
625
for j = 1:size(isQuestionToAsk, 1)

‎src/gui/setDefaultResponses.m‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
% (C) Copyright 2020 CPP_BIDS developers
22

33
function [cfg, responses] = setDefaultResponses(cfg)
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
% :type argin3: integer
19+
%
20+
% :returns: - :argout1: (type) (dimension)
21+
% - :argout2: (type) (dimension)
22+
%
423

524
if nargin < 1
625
cfg = struct('debug', []);

0 commit comments

Comments
 (0)