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

Standardize antibody names from antibodies.tsv contents #6

Open
mkeays opened this issue Mar 10, 2020 · 4 comments
Open

Standardize antibody names from antibodies.tsv contents #6

mkeays opened this issue Mar 10, 2020 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@mkeays
Copy link
Contributor

mkeays commented Mar 10, 2020

Currently convert_to_ometiff.py adds the antigen names, taken from the Cytokit YAML config (in turn taken from the submitted channel names array), to the Channel element Name attribute. However, because different antibodies can be used to detect the same antigen, we should also add details of the antibody used to detect the antigen to the OME-XML.

To begin with this could go in the Channel element Name attribute as well, but we need to research if there is a more appropriate place for this in the OME-XML. Details that should be added are the antibody name, and the Antibody Registry ID.

Bob suggested adding in the following format: (antibody name)(antibody registry ID)(antigen name) e.g. (rabbit monoclonal anti-human CD8-alpha)(AB_2800052)(CD8e)

@mkeays mkeays self-assigned this Mar 10, 2020
@mkeays mkeays added the enhancement New feature or request label Mar 10, 2020
@mkeays
Copy link
Contributor Author

mkeays commented Mar 10, 2020

The microscopy DRT is currently working on a tabular file to list details of all antibodies used in all datasets, indexed by dataset UUID. This would mean that for each dataset, we could pull out the exact antibody name and AR ID for each antigen, from this file. We're waiting for this file to be ready before we can add this to the code.

@mruffalo
Copy link
Contributor

The information in antibodies.tsv in newer HuBMAP datasets may be usable for this. We should read this file if present, and either

  • use this to adjust channel names in the OME-XML output
  • add additional metadata (alternate channel names or something) that would be usable by the portal and downstream consumers like the Cells API indexing

@mruffalo mruffalo changed the title Add antibody names and IDs to extract OME-XML Standardize antibody names from antibodies.tsv contents Aug 1, 2023
@mruffalo
Copy link
Contributor

mruffalo commented Aug 1, 2023

Sean made a lot of progress on this in a branch -- assigning to Penny.

Replacing the channel names is relatively easy; I believe @SFD5311 encountered some issues with adding the previous channel names as structured annotations.

@pennycuda
Copy link
Contributor

Just sorted the antibodies file by cycle number in convert_to_ometiff.py, still working on the rest of this issue

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

3 participants