Back to SimpleMetrics page.
The ResidueSummaryMetric takes a PerResidueRealMetric and summarizes the data in various ways, such as the mean, sum, or the number of residues above, below, or equal to a certain value. This Metric is itself a RealMetric and can be used as such in filters, features reporters, etc.
Autogenerated Tag Syntax Documentation:
Author: Jared Adolf-Bryfogle (email@example.com) A SimpleMetric that takes a PerResidueRealMetric and calculates different summaries of the overall data. This metric can calculate means, totals, or the number of residues (n_res) matching certain criteria. Useful for summarizing metrics or using more complex functionality in the SimpleMetricFilter
Be sure to set a custom_type to label the summary type in which you are calculating!.
<ResidueSummaryMetric name="(&string;)" custom_type="(&string;)" epsilon="(.0001 ℜ)" metric="(&string;)" action="(mean &summary_types;)" action_value="(ℜ)" use_cached_data="(false &bool;)" cache_prefix="(&string;)" cache_suffix="(&string;)" fail_on_missing_cache="(true &bool;)" />
epsilon: Significant digits used for equal operators
IE: The absolute value of the difference between two numbers, below which they will be considered to be equal. Used when comparing numbers if action = n_res_eq or n_res_ne.