[ENH] add extra files to derivatives datasets (#883)

* add extra files to derivatives datasets

* silence octave failing test

Author: Remi-Gau

src/IO/addGitIgnore.m

@@ -0,0 +1,34 @@
+function addGitIgnore(fullpath)
+  %
+  % Adds a basic gitignore
+  %
+  % USAGE::
+  %
+  %   addGitIgnore(fullpath)
+  %
+  % :type  fullpath:
+  % :param fullpath: char
+  %
+
+  % (C) Copyright 2022 bidspm developers
+
+  outputFile = fullfile(fullpath, '.gitignore');
+
+  if exist(outputFile, 'file') == 2
+
+    fid = fopen(outputFile, 'a+');
+
+    c = fread(fid, Inf, 'uint8=>char')';
+    if ~numel(strfind(c, '.DS_store')) > 0
+      fprintf(fid, '.DS_store\n');
+    end
+
+    fclose(fid);
+
+  else
+    fid = fopen(outputFile, 'w');
+    fprintf(fid, '.DS_store\n');
+    fclose(fid);
+  end
+
+end

src/IO/addReadme.m

@@ -0,0 +1,23 @@
+function addReadme(fullpath)
+  %
+  % Adds a basic README
+  %
+  % USAGE::
+  %
+  %   addReadme(fullpath)
+  %
+  % :type  fullpath:
+  % :param fullpath: char
+  %
+
+  % (C) Copyright 2022 bidspm developers
+
+  outputFile = fullfile(fullpath, 'README.md');
+
+  if exist(outputFile, 'file') == 2
+
+  else
+    fid = fopen(outputFile, 'w');
+    fprintf(fid, '# README\n');
+    fclose(fid);
+  end

src/bids/initBids.m

@@ -56,6 +56,9 @@ function initBids(varargin)
 
   end
 
+  addGitIgnore(opt.dir.output);
+  addReadme(opt.dir.output);
+
 end
 
 function version = getDefaultBIDSVersion()

src/utils/isTtest.m src/stats/utils/isTtest.msrc/utils/isTtest.m renamed to src/stats/utils/isTtest.m

@@ -0,0 +1,76 @@
+% (C) Copyright 2020 bidspm developers
+
+function test_suite = test_addGitIgnore %#ok<*STOUT>
+  try % assignment of 'localfunctions' is necessary in Matlab >= 2016
+    test_functions = localfunctions(); %#ok<*NASGU>
+  catch % no problem; early Matlab versions can use initTestSuite fine
+  end
+  initTestSuite;
+end
+
+function test_addGitIgnore_basic()
+
+  if exist(fullfile(pwd, '.gitignore'), 'file')
+    delete(fullfile(pwd, '.gitignore'));
+  end
+
+  addGitIgnore(pwd);
+
+  assertEqual(exist(fullfile(pwd, '.gitignore'), 'file'), 2);
+
+  fid = fopen(fullfile(pwd, '.gitignore'), 'r');
+  c = fread(fid, Inf, 'uint8=>char')';
+
+  assertEqual(strfind(c, '.DS_store'), 1);
+
+  fclose(fid);
+
+  delete(fullfile(pwd, '.gitignore'));
+
+end
+
+function test_addGitIgnore_already_present()
+
+  if exist(fullfile(pwd, '.gitignore'), 'file')
+    delete(fullfile(pwd, '.gitignore'));
+  end
+  fid = fopen(fullfile(pwd, '.gitignore'), 'w');
+  fprintf(fid, 'foo\n');
+  fprintf(fid, '.DS_store\n');
+  fclose(fid);
+
+  addGitIgnore(pwd);
+
+  fid = fopen(fullfile(pwd, '.gitignore'), 'r');
+  c = fread(fid, Inf, 'uint8=>char')';
+  assertEqual(numel(strfind(c, '.DS_store')), 1);
+
+  fclose(fid);
+
+  delete(fullfile(pwd, '.gitignore'));
+end
+
+function test_addGitIgnore_append()
+
+  if isOctave()
+    return
+  end
+
+  if exist(fullfile(pwd, '.gitignore'), 'file')
+    delete(fullfile(pwd, '.gitignore'));
+  end
+
+  fid = fopen(fullfile(pwd, '.gitignore'), 'w');
+  fprintf(fid, 'foo\n');
+  fprintf(fid, 'bar\n');
+  fclose(fid);
+
+  addGitIgnore(pwd);
+
+  fid = fopen(fullfile(pwd, '.gitignore'), 'r');
+  c = fread(fid, Inf, 'uint8=>char')';
+  assert(strfind(c, '.DS_store') > 0);
+  fclose(fid);
+
+  delete(fullfile(pwd, '.gitignore'));
+end