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

DOC: Document a good example of make_dataset_description #1024

Closed
larsoner opened this issue Jul 28, 2022 · 3 comments · Fixed by #1029
Closed

DOC: Document a good example of make_dataset_description #1024

larsoner opened this issue Jul 28, 2022 · 3 comments · Fixed by #1029
Milestone

Comments

@larsoner
Copy link
Member

We should modify the sample dataset example to use this, showing at least the following fields:

make_dataset_description(
    path=...,
    name=...,
    authors=[...],
    how_to_acknowledge='...',
    data_license='CC-BY-SA',  # or whatever the best one is now, prob. commented out b/c it's not appropriate for 'sample'
    ethics_approvals=['...'],
    references_and_links=['...'],
    overwrite=True)

If someone knows of a good example to follow for this, I can make a PR.

I ask because I'm making my first BIDS-compatible dataset (FINALLY!) and I was hoping to find this in the SG cross-refs for https://mne.tools/mne-bids/stable/generated/mne_bids.make_dataset_description.html#mne_bids.make_dataset_description, but no dice...

@larsoner
Copy link
Member Author

cc @sappelhoff @hoechenberger I assume one of you knows a good example to follow, perhaps even a link to a GH repo with a call to a command I can just lift these from...?

@larsoner
Copy link
Member Author

Should I just adapt https://github.com/sappelhoff/bids-examples/blob/master/ds000248/dataset_description.json so that the example actually produces a dataset_description.json like this?

And maybe also the README like this?

https://github.com/sappelhoff/bids-examples/blob/master/ds000248/README

@sappelhoff
Copy link
Member

I ask because I'm making my first BIDS-compatible dataset (FINALLY!)

🎉

Should I just adapt https://github.com/sappelhoff/bids-examples/blob/master/ds000248/dataset_description.json so that the example actually produces a dataset_description.json like this?
And maybe also the README like this?

sounds reasonable to me!

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

Successfully merging a pull request may close this issue.

2 participants