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

Improve UX for metadata module #664

Open
Lilly-May opened this issue Sep 29, 2024 · 0 comments
Open

Improve UX for metadata module #664

Lilly-May opened this issue Sep 29, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Lilly-May
Copy link
Collaborator

Description of feature

The methods in the metadata module would benefit from revision, especially regarding the parameters. In some cases, the parameter inference and default settings could be improved or, at least, better documented.

Two specific things discussed in scverse/pertpy-tutorials#48:

  • In CellLine.annotate_bulk_rna, the reference_id is implicitly set to DepMap_ID, and a warning is raised to inform the user of the steps to take if that column is not present. This process could be improved by explicitly checking whether DepMap_ID is available in adata.obs and, if it is not, raising an error (or a warning). (see code here)
  • In CellLine.correlate, we check if the gene names are different and issue a warning if they are. We should discuss whether it makes more sense to let the method to fail if the names do not match. If not, the warning should at least clarify the implications of this discrepancy. (see code here)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant