ARTEM-IS web app: working towards an Agreed Reporting Template for EEG Methodology (International Standard)

suzyjstyles commented 3 years ago

Project info

Title: ARTEM-IS web app: working towards an Agreed Reporting Template for EEG Methodology (International Standard)

Project leads: suzyjstyles asoskic

Timezone: +8 (Singapore) +2 (Serbia)

Description: In the EEG 'Garden of Forking Paths,' most research reports do not have enough detail to know which path has been taken, hampering reproducibility, replication and meta-science (Šoškić et al 2021 https://psyarxiv.com/jp6wy/). Our initiative to create an Agreed Reporting Template for an International Standard includes a draft template designed to make reporting EEG methodology easier and more accurate, by providing fields for researchers to input specific methodological details (ARTEM-IS https://doi.org/10.17605/OSF.IO/PDX6Y). Read more about why we need this tool and how you can help to make it better in our preprint: (https://psyarxiv.com/myn7t). Join us in the Hack to make the tools we need.

Link to project: Static docs can be found on the ARTEM-IS OSF: https://doi.org/10.17605/OSF.IO/PDX6Y Editable doc links will be shared directly on Mattermost and in the ARTEM-IS Clubroom in Gathertown ARTEM-IS Clubroom: https://gather.town/app/Bw3fcD2KiO11izhe/artemisclubroom (Password on Mattermost)

Mattermost handle: @suzyjstyles

Goals for the OHBM Brainhack In this hackathon, participants work together to refine and convert fields in the draft template into a structured format making up the backend of a webapp (based on the model of COBIDAS Information Collection Protocol: https://ohbm.github.io/cobidas/#/ ). The webapp helps researchers document methodological details accurately in a simple, un-get-wrong-able form. Participants may also collaborate on revisions and extensions of the draft template to maximise the utility of the tool.

Good first issues: • Translating the existing template fields into a viable eCOBIDAS App (with @Remi-Gau 's generous support) • Updating/refining the template fields, including working on BIDs compatibility

Skills: Want to improve reproducibility, replicability and transparency in EEG? Basic spreadsheet experience and programming skills are both welcome! Experience conducting EEG or describing EEG methods would be a bonus, but not necessary to participate

Chat channel: https://mattermost.brainhack.org/brainhack/channels/artem-is

Participant Capacity: 5-15

Contributions Contributors in the OHBM BrainHack will be acknowledged on a contributors page in the ARTEM-IS OSF Project

Meeting Schedule Launch and daily check-in 10am CET each day Flexible co-working in the ARTEM-IS Clubroom

Onboarding Info Live Onboarding Doc When working on ARTEM-IS documents, please keep our design considerations in mind

Image for the OHBM brainhack website

Project submission

Submission checklist

Once the issue is submitted, please check items in this list as you add under 'Additional project info'

Please include the following above (all required):

[x] Link to your project: could be a code repository, a shared document, etc. See here
[x] Include your Mattermost handle (i.e. your username). If you do not have an account, please sign up here.
[x] Goals for the OHBM Brainhack: describe what you want to achieve during this brainhack. See here.
[x] Flesh out at least 2 "good first issues": those are tasks that do not require any prior knowledge about your project, could be defined as issues in a GitHub repository, or in a shared document, cf here.
[x] Skills: list skills that would be particularly suitable for your project. We ask you to include at least one non-coding skill, cf. here.
[x] Chat channel: A link to a chat channel that will be used during the OHBM Brainhack. This can be an existing channel or a new one. We recommend using the Brainhack space on mattermost, cf. here.
[x] Provide an image of your project for the OHBM brainhack website

You can also include information about (all optional):

[x] Someone co-leading the project in the timeslot you have not selected to provide additional visibility.
[x] Number of participants, cf. here
[ ] Twitter-size summary of your project pitch, cf. here
[ ] Set up a kanban board on your repository to better divide the work and keep track of things, cf here
[ ] Project snippet for the OHBM Brainhack website, cf. here

We would like to think about how you will credit and onboard new members to your project. We recommend reading references from this section. If you'd like to share your thoughts with future project participants, you can include information about (recommended):

[x] Specify how will you acknowledge contributions (e.g. listing members on a contributing page).
[x] Provide links to onboarding documents if you have some.

QMENTA has agreed to sponsor the event and provide computational resources through their platform.

[ ] Get in touch with QMENTA through their Brain Innovation Hub Slack space, if you think your project would benefit from their support.

tiborauer commented 3 years ago

Hi @suzyjstyles, Have you closed this issue because you are no longer interested in submitting it?

asoskic commented 3 years ago

Hi, just to confirm that we are still submitting, I am unsure about why the issue got closed, and I will let Suzy know. :)

johalgermissen commented 3 years ago

Hi @suzyjstyles @asoskic great to see this submitted! Me (and maybe some more people from EEGManyPipelines, currently interrogating options) would be happy to help!

Can you already say a bit more about your plans (e.g. first issues)? What exactly do you plan to work on? Mostly spread-sheet based (pushing the reporting template further), or also the eCOBIDAS App?

suzyjstyles commented 3 years ago

Hi @johalgermissen - great to hear from you! We are excited by the chance to team up with as many of the ManyThings teams as we can! I'm a bit of a noob on this platform so please do bear with us while we figure out how to do stuff...

We have 2 main things planned, exactly as you suggest:

translating the existing template fields into a viable eCOBIDAS App (with @Remi-Gau 's generous support)
updating/refining the template fields i.e., pushing the template further

We expect different people might be interested in different aspects of the work, so we want to make space for both kinds of activity :) Our big push will be on the App side for this event, since a viable App will provide easier opportunities for feedback on the current template structure.

tiborauer commented 3 years ago

@suzyjstyles, Can you, please, update the issue according to the checklist?

suzyjstyles commented 3 years ago

Working on it now :)

suzyjstyles commented 3 years ago

hi @ohbm/project-monitors: I think my project is ready! - sorry for all of the mistakes along the way 😅

suzyjstyles commented 3 years ago

You can find our live Onboarding Doc [here](here: https://docs.google.com/document/d/1hcLGQS2M6cLRTKl_nSurmN8owrQmGfTlJOYe0gaRqPY/edit) When working on ARTEM-IS documents, please keep these design considerations in mind: [Uploading ARTEM-IS_DesignGuidelines.pdf…]()

ohbm / hackathon2021