Skip to contents

This method returns information about the genome.

Details

This method returns a data frame reporting the name (column "name"), the size (column "size"), and the number of alleles (column "num_of_alleles") of each chromosome.

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                                                       

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

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

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

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

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


# get the genome information
m_engine$get_genome_info()
#>   chr     size num_of_alleles
#> 1  22 51304566              2