Improve brainglobe-segmentation 1D segmentation documentation #134
Conversation
There was a problem hiding this comment.
Thanks for this @jingjie-li, much appreciated! I've left a few comments, and some suggestions just to standardise formatting with the rest of the website.
docs/source/documentation/brainglobe-segmentation/user-guide/output-files.md
Outdated
Show resolved
Hide resolved
docs/source/documentation/brainglobe-segmentation/user-guide/output-files.md
Outdated
Show resolved
Hide resolved
docs/source/documentation/brainglobe-segmentation/user-guide/output-files.md
Outdated
Show resolved
Hide resolved
docs/source/documentation/brainglobe-segmentation/user-guide/output-files.md
Outdated
Show resolved
Hide resolved
| You may want to use different [color](https://matplotlib.org/stable/users/explain/colors/colormaps.html) for each probe. | ||
| ::: | ||
|
|
||
| For example: (package importing and rendering code can refer to [this example](https://github.com/brainglobe/brainrender/blob/main/examples/add_cells.py)) |
There was a problem hiding this comment.
Would you mind adding all the extra import/render code, so there is a full example that users can copy and run easily?
There was a problem hiding this comment.
Yes it's better to have a full example here. but it's a bit strange to put that much code in the doc. And it need the .npy file to run. Can I put those as an example in brainrender repo and also attached the example data file and then attach that link here?
There was a problem hiding this comment.
I'm not sure it's so strange. I think it's something that lots of people will want to do. You could either add it to the brainrender examples along with the .npy file (feel free to raise a PR), or just add it here without the data making it obvious where to add the path to the file (e.g. .path/to/brainrender_export.npy).
There was a problem hiding this comment.
I have linked this example to brainrender repo, here is the PR: brainglobe/brainrender#313
adamltyson
changed the title
Co-authored-by: Adam Tyson <[email protected]>
…utput-files.md Co-authored-by: Adam Tyson <[email protected]>
…utput-files.md Co-authored-by: Adam Tyson <[email protected]>
…utput-files.md Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
There was a problem hiding this comment.
Great, thanks @jingjie-li. I made some small changes but I think this is good to go 🎉
No description provided.