datajoint/element-animal

Naming uniformity: `element-animal` -> `element-subject` ?

CBroz1 opened this issue · 11 comments

CBroz1 commented

Other elements are named after their respective primary tables (e.g., lab.Lab and session.Session). element-animal stands out as unique with subject.Subject. The language might also be a minor roadblock for future human-subjects researchers.

CBroz1 commented

Making this changes would be broad in scope across elements, with many small edits across almost all existing workflows. Holding off pending discussion of the best timing for this change.

kabilar commented

Thanks @CBroz1. Good catch. For human subjects, what do you think would be the best naming scheme for the package, schema, and tables?

CBroz1 commented

To use for human subjects, several tables would become unnecessary (e.g., Cage, SubjectCullMethod). Long term (i.e., U24 Year 3+), I think we could develop an alternate element or schema within the current element with more human-relevant tables, such as medical history. In the short term, I think we should preserve consistency of mapping element name to element primary table.

kabilar commented

That sounds good. I do not think that this will cause backwards incompatibility requiring a migration script (Issue #22).

ttngu207 commented

I'm good with this change

  • 👍1
kabilar commented

Thanks all. I will make the updates today for element-animal to element-subject, and will submit for @CBroz1's review. Then we can rename the repository on GitHub.

  • 👍1
kabilar commented

We will also need to modify this package on pypi.

@CBroz1, could you please reach out to Raphael to determine who has the credentials and how to do this?

CBroz1 commented

reach out to Raphael to determine who has the credentials and how to do this (rename on pypi)?

Certainly, will do

  • 👍1
CBroz1 commented

modify this package on pypi.

@kabilar just met with Raphael who suggested the following as our release process. Unfortunately, renaming isn't an option, but we can...

  1. Confirm new name availability ✅ and within-team consensus (flag for Dimitri?)
  2. Issue one more release on old name, inclusive of a readme doc warning disclaimer pointing to the new one. In our current case, this can be a separate PR before merging the outstanding PRs (subject, interface).
  3. Issue an internal engineering request ticket for Drew (on this first occasion, also include Raphael) to start a new pypi repo.

Note: PyPi releases cannot be pulled back only flagged as 'bad' while issuing another.

kabilar commented

Thanks @CBroz1.

  1. @dimitri-yatsenko, we are confirming the package name change from element-animal to element-subject.
  2. Will submit new pull requests today.
  3. Once confirmed by Dimitri, please submit the internal ticket for element-subject. We will not be releasing element-interface on pypi at the present time.
CBroz1 commented

The decision was made to preserve the current naming scheme, discussed here.