Convert results dir structure in a bids-ish way!

[robbisg]

Problem

Use BIDS specs to create dirs and so on!

Every analysis must be included in derivatives folder
the structure must be
<ds-root>/derivatives/<pipeline-name>/<subj-dir>

in the subj dir the files must be named as:
<source_keyword>[_keyword-value]_<suffix>.<ext>
in addition a dataset-description.json must be included.

1. The best solution is that <pipeline-name> is the on provided by AnalysisPipeline or by Analyzer
2. dataset-description.json must include PipelineDescription.Name
3. Maybe we can use keyword-value in file to specify different analyses.
   • A possibility is to use <pipeline-name>-<variant>
4. Each subdir file should be described by a filename.json file with:

TODO

• Every analysis must have a pipeline name
• We must check if dataset is composed by a single subject or by several subjects
• The derivatives/<subdir> must be [pipeline-<pipeline_name>]_analysis-<searchlight | decoding | connectivity>_[<analysis-specific-key>-<value]
• Analyzer must implement _get_pipeline_info to build dir name
• For searchlight analyses we must have derivatives/analsysis-searchlight_radius-0.3
• For decoding analyses we must have derivatives/analysis-roi_decoding_area-brain
• Obtain <source_keywords>
• Analyzer must implement _get_fname_info in order to build filename appropriately.
• Filenames for searchlight analyses must be <source_keywords>_target-<values>_task-<value>_date-<datetime>_num-<number>_<keyf>-<value>_<avg | cv>.nii.gz
• Filenames for decoding analyses must be <source_keywords>_target-<values>_task-<task>_mask-<mask>_value-<roi_value>_date-<datetime>_num-<num>_<key>-<value>_data.mat
• Each filename is paired with filename.json which is our configuration file! Remove hard-coded configuration.json from results.bids package #43
• We can split information about dataset in dataset-description.json at the top of the pipeline dir Remove hard-coded configuration.json from results.bids package #43

Fixes

• Remove underscore from dir and files names Remove underscore from results directories #41
• Analyses with sample_slicer__subjects must share same derivatives dir Analyses with same id and different subj must be in the same dir #42
• Results reader
• Remove hard-coded configuration.json Remove hard-coded configuration.json from results.bids package #43

[robbisg]

Questions

A: If I run the same analysis in two different times?
R: They will share the same dir but the files inside will have different ids
R: Or if you will name the pipeline differently they will have different directory

A: Who is the responsible for creating subject's subdirs??
R: I don't know (but maybe it should be AnalysisPipeline or Analyzer)