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

Image for source / raw / derivatives #105

Open
Remi-Gau opened this issue Nov 5, 2018 · 8 comments
Open

Image for source / raw / derivatives #105

Remi-Gau opened this issue Nov 5, 2018 · 8 comments
Labels
documentation tasks relating to improving our documentation

Comments

@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Nov 5, 2018

I had made this figure to add it to the BIDS specs. But before I make a pull request there I was thinking that we could work on it / add it to the starter kit and then make a PR to the specs.

What do you think?

link on google drive

SVG file made with inkscape if you want to edit it further.

BTW: Is there a good way to version control figure making? git-annex?

bids_rawderivativesource

@dorahermes
Copy link
Member

Very nice!

@KirstieJane
Copy link
Member

Yep! Ditto! In fact - I'm about to use it in a talk at SFN in 1 hours time! GREAT TIMING @Remi-Gau 🙌

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Nov 5, 2018

Awesome! Glad it is being used!
I think @chrisfilo had mentioned (in the google doc days of the BIDS spec) that there should be less detail in the derivatives so I could make something like that for the main specs!

@emdupre
Copy link
Collaborator

emdupre commented Nov 5, 2018

Re: version control for figures, I'd agree that using git-annex is a good option ! I've found this walk-through helpful in the past for setting up special remotes.

Could you clarify what you mean by "less detail in the derivatives" ? Just not sure how it relates to making something different for the main spec, but I'm excited to see this move forward either way ! 🚀 Thanks for bringing this up !

@emdupre
Copy link
Collaborator

emdupre commented Nov 5, 2018

Actually, sorry, thinking through this again -- I think you could add the image directly to github ! It seems small enough.

@emdupre emdupre added the documentation tasks relating to improving our documentation label Nov 5, 2018
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Nov 9, 2018

Should I just add it in an image directory in the root folder of the repository? And also add it in the The BIDS folder hierarchy page of the wiki?

As for less details: when I first added this image to the google doc of the specs, it was suggested that having this example description of content for the derivatives folder might give some the impression that this is what the content of derivatives should look like.

So it might be for example better to have placeholders instead of specific software names pipeline-software-A instead of spm for example.

And I was just bringing up the main spec thinking that we could elaborate on the image in the bids-starter-kit repo and then see if there it could added to the main specs. Not sure I am being clearer.

@dorahermes
Copy link
Member

Thank you!
an image dir in root and BIDS folder hierarchy sounds like good places to me

@Remi-Gau
Copy link
Collaborator Author

BTW: added the image to the wiki .
Looks a bit huge ATM (should it be resized or is there the way to do this on the fly in markdown?) and also the link to the image will have to be changed once #106 has been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation tasks relating to improving our documentation
Projects
None yet
Development

No branches or pull requests

4 participants