Getting the registered species rates

This method returns the registered species rates.

Value

A dataframe containing the registered species rates.

Details

The registered species rates are returned in a dataframe. 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                                     

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

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

 [████████████████████████████------------] 69% [00m:03s] Loading RS index                                    

 [████████████████████████████████████----] 88% [00m:04s] Loading RS index                                    

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

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

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


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