cytomining / cytomining/CytoTable
Consistently handle `Metadata_Well` and `Metadata_Plate` column renaming and join specification
- Dominant language
- Python
- Stars
- 21
- Forks
- 6
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 6
Description
I noticed `Metadata_Well` and `Metadata_Plate` are sometimes handled differently within the preset identifying columns and joins along with column renaming logic found within [`cytotable.convert._prepend_column_name`](https://github.com/cytomining/CytoTable/blob/main/cytotable/convert.py#L386). This can result in tables which include, for example, columns named `Metadata_Well` and `Image_Metadata_Plate`. Creating this issue to better clarify how these columns should be named.
Should `Metadata` labeled columns ever have a table name prefix? For example, is `Image_Metadata_Well` an accurate depiction of `Metadata_Well` (as a metadata column from the image table)?
Contributor guide
Research direction
Start in cytotable/convert.py at _prepend_column_name, then trace the preset identifying columns and join specifications that handle Metadata_Well and Metadata_Plate. Establish the intended naming rule for metadata columns and confirm that the renaming and joins apply it consistently; the issue is done when the expected column names and join behavior are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100