Get started

Simple tutorial using default bayesian method on example file

If not already done, download the archive containing the reference databases and the bayesian models from zenodo.org, using the inborutils package. You can change the path option to where you want to download the archive (default is current directory ‘.’):

remotes::install_github("inbo/inborutils")
inborutils::download_zenodo("10.5281/zenodo.13733183", path=".")

Store the path to the archive containing the reference databases and the bayesian models:

refdata_archive_path = "path/to/genomesizeRdata.tar.gz"

Read the example input file from the package. This example data is a subset of the dataset from Labouyrie et al. 2023:

example_input_file = system.file("extdata", "example_input.csv", package = "genomesizeR")

Load the package:

library(genomesizeR)

Run the main function to get the estimated genome sizes (with the default method which is the bayesian method):

  results = estimate_genome_size(example_input_file, refdata_archive_path, 
            sep='\t', match_column='TAXID', output_format='input', 
            ci_threshold = 0.3)
  
  #############################################################################
  # Genome size estimation summary:
  #
  #  22.22222 % estimations achieving required precision
  #
       Min.   1st Qu.    Median      Mean   3rd Qu.      Max. 
    3007721   5408472  16980834  23969767  41811396 143278734 
  
  # Estimation status:
  Confidence interval to estimated size ratio > ci_threshold      OK 
                                                         140      40 

Plot genome size histogram per sample

Then, the results can be visualized using the plotting functions provided. This histogram shows the estimated genome sizes for each sample.

  plotted_df = plot_genome_size_histogram(results)

Plot genome size histogram for one sample

  plotted_df = plot_genome_size_histogram(results, only_sample='16S_1')

Plot genome size boxplot per sample

This boxplot shows the estimated genome sizes for each sample:

  plotted_df = plot_genome_size_boxplot(results)

Plot genome size boxplot for one sample

  plotted_df = plot_genome_size_boxplot(results, only_sample='ITS_1')

Plot simplified taxonomic tree with colour-coded estimated genome sizes

This tree shows the taxonomic relationships as well as the estimated genome sizes. The difference between the genome size distribution of bacteria (16S marker) and fungi (ITS marker) is visible.

  plotted_df = plot_genome_size_tree(results, refdata_archive_path)

## Untarring reference data
## Using reference data in: /tmp/RtmpBl7nwv/refdata
## Untarring taxonomy
## Using taxonomy: /tmp/RtmpBl7nwv/taxdump