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

use capital letter of each word for axolotl main structures #343

Merged
merged 2 commits into from
Aug 5, 2024

Conversation

alessandrofelder
Copy link
Member

@alessandrofelder alessandrofelder commented Aug 2, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

The draft acronyms for higher-level ("main structure") axolotl brain regions could be nicer.

What does this PR do?

  • Uses the first letter of all words in the higher-level region names as the acronym, as suggested by @adamltyson.
    For example, "Olfactory bulb" is abbreviated OB and "Telencephalon" gets the acronym T.
  • also passes the minor version 0 to the wrapup function, as this will be the first release (1.0.0) of this atlas in BrainGlobe.

References

Closes #341

How has this PR been tested?

Checking that for a locally generated version of the atlas, I can make a NapariAtlasRepresentation and call add_structure_to_viewer("T") and add_structure_to_viewer("OB") on it, and appropriate region meshes appear in 3D. Also, manual inspection of the generated structures.json file.

Is this a breaking change?

Nope

Does this PR require an update to the documentation?

When we publish the atlas, but not right now.

Checklist:

  • The code has been tested locally
  • [n/a] Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

cc @saimaabdus19

@alessandrofelder alessandrofelder marked this pull request as ready for review August 2, 2024 16:51
@alessandrofelder alessandrofelder requested a review from a team August 2, 2024 16:51
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

FYI the version will be 1.0 (not 1.0.0), as yet we don't have patch versions.

@adamltyson adamltyson merged commit d86d2f5 into main Aug 5, 2024
12 of 13 checks passed
@adamltyson adamltyson deleted the improve-axolotl-acronyms branch August 5, 2024 08:20
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 this pull request may close these issues.

[Feature] Get the axolotl region abbreviations checked and improved by an anatomist
2 participants