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

Repurpose Data Analysis section #33

Closed
niksirbi opened this issue Jun 21, 2023 · 5 comments
Closed

Repurpose Data Analysis section #33

niksirbi opened this issue Jun 21, 2023 · 5 comments
Labels
enhancement New feature or request

Comments

@niksirbi
Copy link
Member

The problem

The rationale for the "Data Analysis" section was the following:

  • have sub-sections according to data type: Behaviour, Electrophysiology, Imaging, Histology
  • subdivide each data type into tools, eg. SLEAP
  • Under each tool document common issues we/others encounter and their solutions.

It is clear that this section hasn't been used at all for this purpose, and it's currently an empty husk.

My idea

Instead of using this section for dumping multiple small issues with each tool, we can use it to publish long-form guides for specific analysis use cases. For example, pur "How to run pose estimation on the HPC" guide could be hosted here under "Behaviour".
If we do this, we should rename the section currently named as "Guides". If most things on this page end up being guides, it will be confusing. I'd rename it as "Open Science"

Thoughts @neuroinformatics-unit/neuroinformatics-team ?

@niksirbi niksirbi added the enhancement New feature or request label Jun 21, 2023
@adamltyson
Copy link
Member

All sounds good to me. Maybe each section could have a Troubleshooting subsection that could stay true to the original aims? We're trying to do something similar with brainglobe.

@adamltyson
Copy link
Member

If we do this, we should rename the section currently named as "Guides". If most things on this page end up being guides, it will be confusing. I'd rename it as "Open Science"

This is nice, "data analysis", "programming" and "open science" probably sums up the team's remit pretty well.

@niksirbi
Copy link
Member Author

All sounds good to me. Maybe each section could have a Troubleshooting subsection that could stay true to the original aims? We're trying to do something similar with brainglobe.

I was already thinking of including a "Troubleshooting" heading at the end of each long-form guide, which we could keep updated as people report problems. We could also have a more "general" Troubleshooting section at the level of each data type, but I would not make those if they are empty. We can add them if/when the content emerges?

@adamltyson
Copy link
Member

I was already thinking of including a "Troubleshooting" heading at the end of each long-form guide, which we could keep updated as people report problems. We could also have a more "general" Troubleshooting section at the level of each data type, but I would not make those if they are empty. We can add them if/when the content emerges?

Sounds good

@niksirbi
Copy link
Member Author

I could tackle the re-organisation this Friday, unless something else comes up. We could also look at #8

This was referenced Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants