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.

Sign up for GitHub

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

Jump to bottom

[DOC] Describe what bids-matlab can and cannot do #84

Merged
merged 6 commits into from
Nov 21, 2020
Merged

[DOC] Describe what bids-matlab can and cannot do #84

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bca08fb
update requirements section and explain the general "compatibility" p…
Remi-Gau Nov 7, 2020
e428bc6
add description of what bids-matlab can and cannot do
Remi-Gau Nov 7, 2020
b054acf
Fix typos
gllmflndn Nov 9, 2020
df8eca8
Apply suggestions from code review
Remi-Gau Nov 9, 2020
cea2f60
remove mention of private functions from README
Remi-Gau Nov 9, 2020
9ec110b
Apply suggestions from code review
Remi-Gau Nov 13, 2020
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
34 changes: 33 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,30 @@ Join our chat on the [bids-matlab channel](https://mattermost.brainhack.org/brai
See also [PyBIDS](https://github.com/bids-standard/pybids) for Python and the [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit).


## Features

### What this toolbox can do

- read the layout of a BIDS dataset (see `bids.layout`),
- perform queries on that layout to get information about the subjects, sessions, runs, modalities, metadata... contained within that dataset (see `bids.query`),
- generate a human readable report of the content of BIDS data set containing anatomical MRI, functional MRI, diffusion weighted imaging, field map data (see `bids.report`)
- read and write JSON files (see `bids.util.jsondecode` and `bids.util.jsonencode`) provided that the right [dependencies](#reading-and-writing-json-files) are installed,
- read and write TSV files (see `bids.util.tsvread` and `bids.util.tsvwrite`),

The behavior of this toolbox assumes that it is interacting with a valid BIDS dataset that should have been validated using [BIDS-validator](https://bids-standard.github.io/bids-validator/). Any unvalidated components may produce undefined behavior. Although, if you're BIDS-y enough, the behavior may be predictable.
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved


### What this toolbox cannot do... yet

- parse the layout of "BIDS-derivative compatible" datasets (like fMRIprep),
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
- create BIDS compatible filenames or folder structures for raw or derivatives datasets,
- basic copying of files to help with derivative dataset generation,
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
- generate human readable reports of the content of BIDS data with EEG, MEG, iEEG, physio and events data,
- deal with some of the most recent updates or incoming BIDS extensions (basic derivatives, ASL, PET, BIDS model...)
- ...

We are trying to centralize the requests for new features in this [issue](https://github.com/bids-standard/bids-matlab/issues/60): have a browse to see what could be coming soon or if we have missed something obvious.


## Installation

Expand All @@ -37,7 +61,15 @@ A [tutorial](https://github.com/bids-standard/bids-matlab/blob/master/examples/t

## Requirements

BIDS-MATLAB works with MATLAB R2014a or newer, or Octave 4.2.2 or newer. (It may also work with older versions, but those are not actively supported.)
BIDS-MATLAB works with:

- Octave 5.2.0 or newer
- MATLAB R2014a or newer

We aim for compatibility with the latest stable release of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We aim for compatibility with the latest stable release of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed.
We aim for compatibility with the latest stable major version of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed.

Maybe you should declare support for a full major version series like Octave 5.x instead of just the "latest stable release", which could be interpreted as "exactly 5.2.3" or similar.

Maybe declare a policy about how long Octave major versions are supported? For example, Octave 6.x is right around the corner. How long will you support Octave 5.x once 6.x is out?

And what about a policy for how long older Matlab versions are supported? If you support R2014a forever, you're eventually going to have a lot of Matlab versions to test against, and you'll never get to adopt newer Matlab features.



### Reading and writing JSON files

If you are using MATLAB R2016b or newer, nothing else needs to be installed.

Expand Down