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

Parse settings #101

Merged
merged 23 commits into from
Nov 22, 2023
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions proteobench/io/params/__init__.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are two parameters missing, and I did not find the correspondance in the SDRF doc. But maybe I missed it:
'software_name' for the software tool (that combines a search engine and some algorithms for quantification)
'search_engine_version'

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, me neither. I guess this is something SDRF does intend to have.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you check with Veit? Or anybody else? I think that we don't take any risk any way if we name them this way, No?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, we can decide the name for parameters specific to our needs. SDRF is independent of software tools, so it would not make sense to have this kind of information there.

Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,30 @@
from typing import Optional


# Reference for parameter names
# https://github.com/bigbio/proteomics-sample-metadata/blob/master/sdrf-proteomics/assets/param2sdrf.yml
# new name as comment
@dataclass
class ProteoBenchParameters:
search_engine: Optional[str] = None
software_version: Optional[str] = None
fdr_psm: Optional[str] = None
fdr_peptide: Optional[str] = None
fdr_protein: Optional[str] = None
MBR: Optional[str] = None
precursor_tol: Optional[str] = None
fdr_psm: Optional[str] = None # ident_fdr_psm
fdr_peptide: Optional[str] = None # ident_fdr_peptide
fdr_protein: Optional[str] = None # ident_fdr_protein
MBR: Optional[str] = None # enable_match_between_runs
precursor_tol: Optional[
str
] = None # precursor_mass_tolerance, value and unit not separated
precursor_tol_unit: Optional[str] = None
mlocardpaulet marked this conversation as resolved.
Show resolved Hide resolved
fragment_tol: Optional[str] = None
fragment_tol: Optional[
str
] = None # fragment_mass_tolerance, value and unit not separated
fragment_tol_unit: Optional[str] = None
mlocardpaulet marked this conversation as resolved.
Show resolved Hide resolved
enzyme_name: Optional[str] = None
missed_cleavages: Optional[str] = None
min_pep_length: Optional[str] = None
max_pep_length: Optional[str] = None
fixed_modifications: Optional[str] = None
variable_modifications: Optional[str] = None
max_num_modifications: Optional[str] = None
precursor_charge: Optional[str] = None


# params = ProteoBenchParameters()
# params.search_engine = "MaxQuant"
# params
# %%
enzyme_name: Optional[str] = None # enzyme
missed_cleavages: Optional[str] = None # allowed_miscleavages
min_pep_length: Optional[str] = None # min_peptide_length
max_pep_length: Optional[str] = None # max_peptide_length
fixed_modifications: Optional[str] = None # fixex_mods
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be 'fixed_mods'

variable_modifications: Optional[str] = None # variable_mods
max_num_modifications: Optional[str] = None # max_mods
precursor_charge: Optional[str] = None # min_precursor_charge
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we don't enter all the possible precursor charges, then we should have min_ and max_precursor_charge

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the maximum can be unlimited in some tools?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure. I guess that if this happens, we'll have a missing value there.
What I meant was more that in cases like in MQ, where they give all the charges that they consider, we need to get the min. and max. No?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MQ specifies a range of min. and max. charge. We only have a problem if a tools would e.g. allow peptides with charges 2,3 and 5, but excludes charges with 4. But I guess this is quite uncommon?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, you are absolutely right. There could be an issue in this case. I don't like this.
Do you think that it is/was/should be discussed for the SDRF-extended format? Because this problem can also arise for them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case yes, as we should not diverge from SDRF-extended.

Loading