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.

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

Migrating Documentation from WIKI to README #159

Merged
merged 4 commits into from
May 8, 2019
Merged

Migrating Documentation from WIKI to README #159

merged 4 commits into from
May 8, 2019

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented May 4, 2019

This PR fixes #74, by making the documentation on available datasets more accessible and providing a table that shows (approximately) which modalities are present in each dataset.

Also fixes #154 to some extend, by adding all available links to the full data. The rest will have to be added by the respective dataset-authors later on.

The table is quite large although I tried hard to cut down on complexity. I would be very grateful for a review and some feedback.

Note that I also inserted a comment in the README, that we are interested in new examples as long as ... they cover some aspects that are not already covered.

I don't see a point of hosting many datasets here if they are all the same in terms of their structure. Personally, I would even be up for cutting down on some example datasets we are hosting here - so please let me know about your opinion on this as well.

  • Upon merge, delete Wiki

Rendered version: https://github.com/sappelhoff/bids-examples/blob/overhaul_docs/README.md

Google Sheet version: https://docs.google.com/spreadsheets/d/1d9KfmaKvTOpFWgi0Kd-tZGgVTsZk_4BHH9prcgFeigw/edit?usp=sharing

Copy link
Contributor

@effigies effigies left a comment

Choose a reason for hiding this comment

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

LGTM. Very small comments.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@choldgraf
Copy link
Collaborator

The formatting looks good to me - I agree that the signal-to-noise is hurt by having so many datasets with overlapping structure. I'd rather something like:

  1. Figure out the different patterns that should be highlighted, make sure there's one dataset that does this well.
  2. Add links to other examples of the same dataset, or maintain a separate page that simply lists all of the datasets that are accessible (maybe just link to OpenNeuro?).

The challenge with the current setup is that the repo serves two purposes: one is to show what the BIDS structure is like, another is to list lots of different examples. I think these are two separate goals that deserve two separate pages. (though doesn't need to be in this PR)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@franklin-feingold
Copy link
Contributor

thank you @sappelhoff for raising this! I can help fill in the bit.ly for openneuro sets. We tried to preserve the ds assession number consistency when merging from openfmri to openneuro. I agree with @choldgraf for two different lists. The more categorized by type (with a coupe of representative examples) can be the more top level/easy to find and if a user needs more examples within a category then this can be linked out to the master list with the collection of all the datasets. The category classification may be challenging to determine the optimal level of abstraction. I think best in a different PR.

@sappelhoff
Copy link
Member Author

sappelhoff commented May 7, 2019

Thanks for the round of reviews everybody!

Let's move on and get this PR ready for merging and then tackle the next issue of "making the overview more concise" in a new PR.

@franklin-feingold I'll give you edit access to the Google Sheet, and it'd be great if you could help me filling it up with the missing information / links to openneuro (instead of the bit.ly ones)

One additional thing: For the modality columns in the table, I'll change the x markings of when a modality is present to a repetition of that modalities name (mri, eeg, ...) --> this will make it easier to scroll down a long table and still know for each row, which modalities are present, without having to go back up to the header.

sappelhoff and others added 2 commits May 7, 2019 13:59
Co-authored-by: Franklin Feingold <35307458+franklin-feingold@users.noreply.github.com>
@sappelhoff sappelhoff merged commit 4fed399 into bids-standard:master May 8, 2019
@sappelhoff sappelhoff deleted the overhaul_docs branch May 8, 2019 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add links to download the full iEEG examples sub-folders for modalities
5 participants