pulsatrix 1.1.0
Loading...
Searching...
No Matches
proteingym.hpp File Reference

Running ProteinGym's deep-mutational-scanning substitution benchmarks (PLM-3): read an assay, score every variant with a protein language model, and compute ProteinGym's metrics. More...

#include <string>
#include <vector>
#include "pulsatrix/fitness_metrics.hpp"
#include "pulsatrix/variant_scoring.hpp"
Include dependency graph for proteingym.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  pulsatrix::ProteinGymAssay
 One assay's row of ProteinGym's reference file (DMS_substitutions.csv). More...
 
struct  pulsatrix::DmsVariants
 An assay's measured variants: mutant, DMS_score and DMS_score_bin columns. More...
 
struct  pulsatrix::AssayResult
 One assay's result. More...
 

Namespaces

namespace  pulsatrix
 

Enumerations

enum class  pulsatrix::VariantStrategy { pulsatrix::MaskedMarginals , pulsatrix::WildTypeMarginals }
 How variants are scored. More...
 

Functions

std::vector< ProteinGymAssay > pulsatrix::ReadProteinGymReference (const std::string &path)
 Every assay in a reference file.
 
DmsVariants pulsatrix::ReadDmsVariants (const std::string &path)
 Reads an assay's CSV.
 
AssayResult pulsatrix::EvaluateAssay (VariantScorer &scorer, const ProteinGymAssay &assay, const DmsVariants &variants, VariantStrategy strategy=VariantStrategy::MaskedMarginals)
 Scores every variant of assay and evaluates them against the measurements.
 

Detailed Description

Running ProteinGym's deep-mutational-scanning substitution benchmarks (PLM-3): read an assay, score every variant with a protein language model, and compute ProteinGym's metrics.