metrics: Retrieve metrics from a result_model, result_collection, or...

In campbio/musicatk: Mutational Signature Comprehensive Analysis Toolkit

Retrieve metrics from a result_model, result_collection, or musica object

Description

Metrics for the model

Usage

metrics(x, ...)

## S4 method for signature 'musica'
metrics(x, result, modality, model_id)

## S4 method for signature 'result_collection'
metrics(x, modality, model_id)

## S4 method for signature 'result_model'
metrics(x)

metrics(x, ...) <- value

## S4 replacement method for signature 'musica,SimpleList'
metrics(x, result, modality, model_id) <- value

## S4 replacement method for signature 'result_collection,SimpleList'
metrics(x, modality, model_id) <- value

## S4 replacement method for signature 'result_model,SimpleList'
metrics(x) <- value

Arguments

x	A musica, result_collection, or result_model object generated by a mutational discovery or prediction tool.
...	Other inputs
result	Name of result from result_list to assign the metrics. Used when result is a musica object.
modality	Modality to assign the metrics. Used when result is a musica or result_collection object.
model_id	Model identifier to assign the metrics. Used when result is a musica or result_collection object.
value	List of metrics

Value

The metrics for the model

Examples

data(res)
metrics(res, "result", "SBS96", "res")

campbio/musicatk documentation built on Dec. 25, 2024, 9:34 p.m.