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

Apply object-oriented principles including a namespace package #3

Open
vijayiyer05 opened this issue Oct 15, 2021 · 2 comments
Open
Assignees

Comments

@vijayiyer05
Copy link
Collaborator

vijayiyer05 commented Oct 15, 2021

The use of namespaced packages is a growing best practice. It would allow EXTRACT to be installed into any MATLAB installation without any function name collisions.

For instance, there could be a top-level +extract package from which EXTRACT-associated functions could be called unambiguously: >> extract.cell_check

As time permits, further use of object-oriented programming principles might be considered, such as an object model which defines a class consolidating the EXTRACT hyperparameters as class properties.

ℹ️ This issue is a refactor so work on a separate branch/fork is essential

@vijayiyer05
Copy link
Collaborator Author

@dimitri-yatsenko, @yambottle, @manisha-sinha-appasamy : good discussion last week.

We spoke about the motivation for the core goal (package namespacing): this is to help support future integration of EXTRACT into broader frameworks and even potentially managed environments such as the DataJoint services.

I'd also like to give @bahanonu a chance to weigh in. He suggested that package namespacing would improve the EXTRACT integration into CIATAH. He also has used package namespaces for CIATAH itself.

@vijayiyer05
Copy link
Collaborator Author

@yambottle Thanks for the recent(ish) overview of your progress on this Issue.

Here are some suggestions:

  • As part of presenting a full vision for the folder org as part of this package refactor, suggest to rename the two root-level folders:

    • "Learning materials" --> "Tutorials"
    • "Template scripts" --> "Examples"
  • Rename +externals to +external (matches common convention)

  • Rename +helpers into +internal

  • Move +debug into +internal*

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

No branches or pull requests

3 participants