Merge pull request #5 from Remi-Gau/master

Add README and implement travis CI

Author: Remi-Gau

.travis.yml

@@ -0,0 +1,34 @@
+# Travis CI (https://travis-ci.org/)
+
+language: c
+dist: bionic
+cache:
+  apt: true # only works with Pro version
+
+env:
+  global:
+    - OCTFLAGS="--no-gui --no-window-system --silent"
+
+before_install:
+  - travis_retry sudo apt-get -y -qq update
+  - travis_retry sudo apt-get -y install octave
+  - travis_retry sudo apt-get -y install liboctave-dev
+  - travis_retry sudo apt-get -y install nodejs
+  - travis_retry sudo apt-get -y install npm
+
+install:
+  # Install JSONio
+  #- travis_retry git clone git://github.com/gllmflndn/JSONio.git --depth 1
+  #- cd JSONio; mkoctfile --mex jsonread.c jsmn.c -DJSMN_PARENT_LINKS; cd ..
+  #- octave $OCTFLAGS --eval "addpath (fullfile (pwd, 'JSONio')); savepath ();"
+  # Install BIDS-MATLAB
+  - octave $OCTFLAGS --eval "addpath (pwd); savepath ();"
+  # Install BIDS-Validator
+  #- sudo npm install -g bids-validator
+
+before_script:
+  # Change current directory
+  - cd tests
+
+script:
+  - octave $OCTFLAGS --eval "results = runtests; assert(all(~[results.Failed]))"

README.md

@@ -0,0 +1,28 @@
+# CPP_BIDS
+
+A set of function for matlab and octave to create [BIDS-compatible](https://bids-specification.readthedocs.io/en/stable/) folder structure and filenames for the output of behavioral, EEG, fMRI, eyetracking studies.
+
+
+## Contributing
+
+Feel free to open issues to report a bug and ask for improvements.
+
+### Guidestyle
+
+-   We use camelCase.
+-   We keep the McCabe complexity as reported by the [check_my_code function](https://github.com/Remi-Gau/matlab_checkcode) below 15.
+
+
+## Functions descriptions
+
+
+### userInputs
+
+
+### createFilename
+
+
+### saveEventsFile
+
+
+### checkCFG

tests/runtests.m

@@ -0,0 +1,51 @@
+function results = runtests(pth)
+% Run tests
+% List all the 'test_*.m' files located in the same directory as this
+% function, run them and keep track of how many passed, failed or are
+% incomplete.
+%__________________________________________________________________________
+
+% Copyright (C) 2019, Guillaume Flandin, Wellcome Centre for Human Neuroimaging
+% Copyright (C) 2020--, CPP_BIDS developers
+
+%-Get the path of where this file is located
+if ~nargin, pth = fileparts(mfilename('fullpath')); end
+
+%-List all the 'test_*.m' files located in the same directory as this
+% function
+d = dir(pth);
+d([d.isdir]) = [];
+d(arrayfun(@(x) isempty(regexp(x.name,'^test_.*\.m$','once')),d)) = [];
+
+results = struct('Passed',{},'Failed',{},'Incomplete',{},'Duration',{});
+for i=1:numel(d)
+
+    results(i).Failed = false;
+    results(i).Passed = false;
+    results(i).Incomplete = false;
+
+    tstart = tic;
+
+    %-Run each test file and catch error message in case of failure
+    try
+
+        fprintf('%s',d(i).name(1:end-2));
+        feval(d(i).name(1:end-2));
+        results(i).Passed = true;
+        
+    catch err
+        results(i).Failed = true;
+        fprintf('\n%s',err.message);
+    end
+
+    results(i).Duration = toc(tstart);
+
+    fprintf('\n');
+
+end
+
+if ~nargout
+    fprintf(['Totals (%d tests):\n\t%d Passed, %d Failed, %d Incomplete.\n' ...
+        '\t%f seconds testing time.\n\n'],numel(results),nnz([results.Passed]),...
+        nnz([results.Failed]),nnz([results.Incomplete]),sum([results.Duration]));
+end

test/test_createFilename.m tests/test_createFilename.mtest/test_createFilename.m renamed to tests/test_createFilename.m

@@ -1,13 +1,9 @@
-% test for filename creation and their directories
-
-% add parent folder to the parth
-addpath(genpath(fullfile(fileparts(mfilename), '..')))
+function test_createFilename()
 
+% test for filename creation and their directories
 
 %% check directory and filename creation (PC and eyetracker)
 
-clear
-
 expParameters.subjectGrp = '';
 expParameters.subjectNb = 1;
 expParameters.sessionNb = 1;

test/test_saveEventsFile.m tests/test_saveEventsFile.mtest/test_saveEventsFile.m renamed to tests/test_saveEventsFile.m

@@ -1,13 +1,8 @@
+function test_saveEventsFile()
 % test for events.tsv file creation
 
-% add parent folder to the parth
-addpath(genpath(fullfile(fileparts(mfilename), '..')))
-
-
 %% set up
 
-clear
-
 expParameters.subjectGrp = '';
 expParameters.subjectNb = 1;
 expParameters.sessionNb = 1;