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

Detect compartments in the single cell input file and throw a warning if they are not used #114

Open
gwaybio opened this issue Dec 15, 2020 · 2 comments
Labels
bug Something isn't working enhancement New feature or request

Comments

@gwaybio
Copy link
Member

gwaybio commented Dec 15, 2020

In #111 - I add a method in the cells.py class to merge tables using predefined "linking" columns.

If there are more than the default compartments in the provided input file (e.g. single cell SQLite), then the merge_single_cells() method will silently ignore the additional compartments if the method is not used properly.

We should throw a warning if there is a missing table not used.

@gwaybio gwaybio added bug Something isn't working enhancement New feature or request labels Dec 15, 2020
@jenna-tomkinson
Copy link
Member

@gwaybio

Can you clarify what you mean by if the method is not used properly? This will help make clear how a user should use this class and we can add documentation.

@gwaybio
Copy link
Member Author

gwaybio commented Jun 7, 2023

Can you clarify what you mean by if the method is not used properly?

The user must specify which compartments are present in the SingleCells(compartments=?) class attribute

compartments : list of str, default ["cells", "cytoplasm", "nuclei"]

If the user is using non-canonical compartments and they fail to specify them, pycytominer will not know to include them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants