summarise_result {minSNPs}R Documentation

summarise_result

Description

summarise_result calculate the MCC score given the SNP sets, training, validation and metadata(s).

Usage

summarise_result(
  snp_sets,
  training_seqs,
  validation_seqs,
  training_metadata,
  validation_metadata,
  priority,
  is_multi = TRUE,
  return_all_intermediate = FALSE,
  is_percent = FALSE
)

Arguments

snp_sets

the dataframe containing the truth and predicted target

training_seqs

the training sequences

validation_seqs

the validation sequences

training_metadata

the training metadata

validation_metadata

the validation metadata

priority

the priority of the target, generated by generate_prioritisation

is_multi

Whether to use MCC-multi or MCC

return_all_intermediate

whether to return all intermediate values, only possible for binary class

is_percent

whether to return result by considering all the profiles having a GOI as target profile

Value

Will return the summarised result


[Package minSNPs version 0.2.0 Index]