juaml/junifer

Watch

Fork 0

[DOC]: How to add custom parcellations and friends? #166

New issue

Closed

opened 2023-01-04 12:40:18 +00:00 by synchon · 10 comments

synchon commented

2023-01-04 12:40:18 +00:00

(Migrated from github.com)

Which element of the documentation do you want to modify and why?

I would like to add my custom parcellation but the docs don't tell you exactly how. So, would be great to have an example.

Anything else to say?

No response

### Which element of the documentation do you want to modify and why? I would like to add my custom parcellation but the docs don't tell you exactly how. So, would be great to have an example. ### Anything else to say? _No response_

LeSasse commented

2023-03-24 07:45:25 +00:00

(Migrated from github.com)

I could add an example, if you tell me where to put it maybe @synchon ?

fraimondo commented

2023-03-24 08:25:33 +00:00

(Migrated from github.com)

I guess the Extending Junifer section of the docs needs to be improved:

https://juaml.github.io/junifer/main/extending/index.html

I guess the `Extending Junifer` section of the docs needs to be improved: https://juaml.github.io/junifer/main/extending/index.html

synchon commented

2023-03-24 09:07:27 +00:00

(Migrated from github.com)

I would actually create a new subsection under https://juaml.github.io/junifer/main/extending/index.html named as "Adding parcellations" and put it there.

I would actually create a new subsection under https://juaml.github.io/junifer/main/extending/index.html named as `"Adding parcellations"` and put it there.

fraimondo commented

2023-03-24 09:16:07 +00:00

(Migrated from github.com)

I would create another section named "Adding data", with subsection for masks, parcellations and coordinates.

synchon commented

2023-03-24 09:19:25 +00:00

(Migrated from github.com)

I would create another section named "Adding data", with subsection for masks, parcellations and coordinates.

My reasoning was due to the fact that we have specific subsections here https://juaml.github.io/junifer/main/builtin.html so one reading the next chapter can connect directly but I am okay with your suggestion as well.

> I would create another section named "Adding data", with subsection for masks, parcellations and coordinates. My reasoning was due to the fact that we have specific subsections here https://juaml.github.io/junifer/main/builtin.html so one reading the next chapter can connect directly but I am okay with your suggestion as well.

fraimondo commented

2023-03-24 09:21:10 +00:00

(Migrated from github.com)

yes, but I meant in the extending section. In the current doc, it means adding section "6.4: Adding data"

synchon commented

2023-03-24 09:26:35 +00:00

(Migrated from github.com)

yes, but I meant in the extending section. In the current doc, it means adding section "6.4: Adding data"

Yeah I got that and my reply was based on that. My suggestion:

6.4 Adding Parcellations
6.5 Adding Coordinates
6.6 Adding Masks

Your suggestion:

6.4 Adding data
6.4.1 Adding Parcellations
6.4.2 Adding Coordinates
6.4.3 Adding Masks

Right?

> yes, but I meant in the extending section. In the current doc, it means adding section "6.4: Adding data" Yeah I got that and my reply was based on that. My suggestion: ``` 6.4 Adding Parcellations 6.5 Adding Coordinates 6.6 Adding Masks ``` Your suggestion: ``` 6.4 Adding data 6.4.1 Adding Parcellations 6.4.2 Adding Coordinates 6.4.3 Adding Masks ``` Right?

fraimondo commented

2023-03-24 09:28:22 +00:00

(Migrated from github.com)

Exactly. I'm fine with any of these options.

👍 1

LeSasse commented

2023-03-24 09:39:56 +00:00

(Migrated from github.com)

so i can add a file, say adding_parcellations.rst, here: https://github.com/juaml/junifer/tree/main/docs/extending

so i can add a file, say `adding_parcellations.rst`, here: https://github.com/juaml/junifer/tree/main/docs/extending

synchon commented

2023-03-24 09:41:49 +00:00

(Migrated from github.com)

so i can add a file, say adding_parcellations.rst, here: https://github.com/juaml/junifer/tree/main/docs/extending

I would keep it as parcellation.rst for consistency.

> so i can add a file, say `adding_parcellations.rst`, here: https://github.com/juaml/junifer/tree/main/docs/extending I would keep it as `parcellation.rst` for consistency.

👍 1