Getting the registered species rates

This method returns the registered species rates.

Value

A data frame containing the registered species rates.

Details

The registered species rates are returned in a data frame. The column species contains the species names; the columns SNV_rate, CNA_rate, and indel_rate store the SNV, CNA, and indel rates, respectively.

Examples

# build a mutation engine
m_engine <- MutationEngine(setup_code = "demo")
#> 
 [█---------------------------------------] 0% [00m:00s] Loading context index                                                  

 [████████████████████████████████████████] 100% [00m:00s] Context index loaded                                                 

#> 
 [█---------------------------------------] 0% [00m:00s] Loading RS index                                                       

 [█████████████████-----------------------] 40% [00m:01s] Loading RS index                                                      

 [████████████████████████████████--------] 78% [00m:02s] Loading RS index                                                      

 [████████████████████████████████████████] 100% [00m:02s] RS index loaded                                                      

#> 
 [█---------------------------------------] 0% [00m:00s] Loading germline                                                       

 [████████████████████████████████████████] 100% [00m:00s] Germline loaded                                                      


# get the active germline subject data frame
head(m_engine$get_species_rates(), 5)
#> [1] species    SNV_rate   CNA_rate   indel_rate
#> <0 rows> (or 0-length row.names)