use std::{
borrow::Cow,
marker::PhantomData,
ops::Range,
path::{Path, PathBuf},
sync::OnceLock,
};
use serde::{Deserialize, Serialize};
use crate::{
BoxedIdentifiedPeptideIter, FastaIdentifier, IdentifiedPeptidoform, IdentifiedPeptidoformData,
IdentifiedPeptidoformSource, IdentifiedPeptidoformVersion, KnownFileFormat, MetaData,
PeptidoformPresent, SpectrumId, SpectrumIds,
common_parser::{Location, OptionalColumn},
};
use mzcore::{
csv::{CsvLine, parse_csv},
ontology::Ontologies,
sequence::{
CompoundPeptidoformIon, FlankingSequence, Peptidoform, SemiAmbiguous,
SloppyParsingParameters,
},
system::{Mass, MassOverCharge, Time, isize::Charge},
};
static NUMBER_ERROR: (&str, &str) = (
"Invalid InstaNovo line",
"This column is not a number but it is required to be a number in this format",
);
static BUILT_IN_MODIFICATIONS: OnceLock<SloppyParsingParameters> = OnceLock::new();
format_family!(
InstaNovo,
SemiAmbiguous, PeptidoformPresent, [&INSTANOVO_V1_0_0, &INSTANOVOPLUS_V1_1_4], b',', None;
required {
scan_number: usize, |location: Location, _| location.parse(NUMBER_ERROR);
mz: MassOverCharge, |location: Location, _| location.parse::<f64>(NUMBER_ERROR).map(MassOverCharge::new::<mzcore::system::thomson>);
z: Charge, |location: Location, _| location.parse::<isize>(NUMBER_ERROR).map(Charge::new::<mzcore::system::e>);
raw_file: PathBuf, |location: Location, _| Ok(Path::new(&location.get_string()).to_owned());
peptide: Peptidoform<SemiAmbiguous>, |location: Location, ontologies: &Ontologies| Peptidoform::sloppy_pro_forma(
location.full_line(),
location.location.clone(),
ontologies,
BUILT_IN_MODIFICATIONS.get_or_init(|| SloppyParsingParameters {
replace_mass_modifications: Some(vec![
ontologies.unimod().get_by_index(&35).unwrap(),
ontologies.unimod().get_by_index(&21).unwrap(),
ontologies.unimod().get_by_index(&4).unwrap(),
]),
..Default::default()
})).map_err(BoxedError::to_owned);
score: f64, |location: Location, _| location.parse::<f64>(NUMBER_ERROR);
}
optional {
local_confidence: Vec<f64>, |location: Location, _| location
.trim_start_matches("[").trim_end_matches("]")
.array(',')
.map(|l| l.parse::<f64>(NUMBER_ERROR))
.collect::<Result<Vec<_>, _>>();
used_model: UsedModel, |location: Location, _| location.parse::<UsedModel>(("Invalid InstaNovo line", "The selected model has to be 'diffusion' or 'transformer'."));
}
fn post_process(_source: &CsvLine, mut parsed: Self, _ontologies: &Ontologies) -> Result<Self, BoxedError<'static, BasicKind>> {
if let Some(used_model) = parsed.used_model && used_model == UsedModel::Diffusion {
parsed.local_confidence = None;
}
if let Some(local_confidence) = parsed.local_confidence.as_mut() && !parsed.peptide.get_n_term().is_empty() {
*local_confidence = local_confidence[parsed.peptide.get_n_term().len()..].to_vec();
}
Ok(parsed)
}
);
pub const INSTANOVO_V1_0_0: InstaNovoFormat = InstaNovoFormat {
version: InstaNovoVersion::V1_0_0,
scan_number: "scan_number",
mz: "precursor_mz",
z: "precursor_charge",
raw_file: "experiment_name",
peptide: "preds",
score: "log_probs",
local_confidence: OptionalColumn::Required("token_log_probs"),
used_model: OptionalColumn::NotAvailable,
};
pub const INSTANOVOPLUS_V1_1_4: InstaNovoFormat = InstaNovoFormat {
version: InstaNovoVersion::PlusV1_1_4,
scan_number: "scan_number",
mz: "precursor_mz",
z: "precursor_charge",
raw_file: "experiment_name",
peptide: "final_prediction",
score: "final_log_probabilities",
local_confidence: OptionalColumn::Optional("transformer_token_log_probabilities"),
used_model: OptionalColumn::Required("selected_model"),
};
#[derive(
Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, Serialize, Deserialize,
)]
pub enum InstaNovoVersion {
#[default]
V1_0_0,
PlusV1_1_4,
}
impl std::fmt::Display for InstaNovoVersion {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "{}", self.name())
}
}
impl IdentifiedPeptidoformVersion<InstaNovoFormat> for InstaNovoVersion {
fn format(self) -> InstaNovoFormat {
match self {
Self::V1_0_0 => INSTANOVO_V1_0_0,
Self::PlusV1_1_4 => INSTANOVOPLUS_V1_1_4,
}
}
fn name(self) -> &'static str {
match self {
Self::V1_0_0 => "v1.0.0",
Self::PlusV1_1_4 => "Plus v1.1.4",
}
}
}
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum UsedModel {
Diffusion,
Transformer,
}
impl std::fmt::Display for UsedModel {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(
f,
"{}",
match self {
Self::Diffusion => "diffusion",
Self::Transformer => "transformer",
}
)
}
}
impl std::str::FromStr for UsedModel {
type Err = ();
fn from_str(value: &str) -> Result<Self, Self::Err> {
if value.eq_ignore_ascii_case("diffusion") {
Ok(Self::Diffusion)
} else if value.eq_ignore_ascii_case("transformer") {
Ok(Self::Transformer)
} else {
Err(())
}
}
}
impl MetaData for InstaNovoData {
fn compound_peptidoform_ion(&self) -> Option<Cow<'_, CompoundPeptidoformIon>> {
Some(Cow::Owned(self.peptide.clone().into()))
}
fn format(&self) -> KnownFileFormat {
KnownFileFormat::InstaNovo(self.version)
}
fn id(&self) -> String {
self.scan_number.to_string()
}
fn confidence(&self) -> Option<f64> {
Some(2.0 / (1.0 + 1.01_f64.powf(-self.score)))
}
fn local_confidence(&self) -> Option<Cow<'_, [f64]>> {
self.local_confidence
.as_ref()
.map(|lc| lc.iter().map(|v| 2.0 / (1.0 + 1.25_f64.powf(-v))).collect())
}
fn original_confidence(&self) -> Option<f64> {
Some(self.score)
}
fn original_local_confidence(&self) -> Option<&[f64]> {
self.local_confidence.as_deref()
}
fn charge(&self) -> Option<Charge> {
Some(self.z)
}
fn mode(&self) -> Option<Cow<'_, str>> {
None
}
fn retention_time(&self) -> Option<Time> {
None
}
fn scans(&self) -> SpectrumIds {
SpectrumIds::FileKnown(vec![(
self.raw_file.clone(),
vec![SpectrumId::Number(self.scan_number)],
)])
}
fn experimental_mz(&self) -> Option<MassOverCharge> {
Some(self.mz)
}
fn experimental_mass(&self) -> Option<Mass> {
Some(self.mz * self.z.to_float())
}
fn protein_names(&self) -> Option<Cow<'_, [FastaIdentifier<String>]>> {
None
}
fn protein_id(&self) -> Option<usize> {
None
}
fn protein_location(&self) -> Option<Range<u16>> {
None
}
fn flanking_sequences(&self) -> (&FlankingSequence, &FlankingSequence) {
(&FlankingSequence::Unknown, &FlankingSequence::Unknown)
}
fn database(&self) -> Option<(&str, Option<&str>)> {
None
}
}