Skip to content

Code and manuscript for benchmarking proteins alignment tools for improved genus delineation using the Percentage Of Conserved Proteins (POCP)

License

Notifications You must be signed in to change notification settings

ClavelLab/pocpbenchmark_manuscript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Analyses workflow for POCP benchmark manuscript

popcbenchmark_manuscript contains the workflow for analyzing data produced by our benchmark ClavelLab/pocpbenchmark. We set out to compare proteins alignment tools for improved genus delineation using the Percentage Of Conserved Proteins (POCP).

A preprint of our work is available at bioRxiv:

Robust genome-based delineation of bacterial genera. Charlie Pauvert, Thomas C.A. Hitch, Thomas Clavel. bioRxiv 2025.03.17.643616; doi: https://doi.org/10.1101/2025.03.17.643616

Setup the environment for the workflow

These analyses were conducted in R 4.3.1 and in Rstudio. We recommend setting up R and specific versions using rig, and getting Rstudio from Posit. We also use renv for reproducible environment, which can be installed in R with install.packages("renv").

  1. Open Rstudio and create a new project via "File > New Project..."
  2. Select "Version Control" and then "Git"
    1. Type https://github.com/ClavelLab/pocpbenchmark_manuscript in Repository URL.
    2. Make sure the project is going to be created in the correct subdirectory on your computer, or else edit accordingly
    3. Click on "Create project"

If you comfortable with the command line and git, clone the repository either with SSH or HTTPS in a suitable location.

  1. Rstudio warns you that One or more packages recorded in the lockfile are not installed because a couple of R packages and dependencies are needed.
    1. Install the dependencies by typing renv::restore() in the Console and agree to the installation of the packages.
    2. Check that all dependencies are set by typing renv::status() in the Console where you should have No issues found

Our analysis workflow is orchestrated by targets and is composed of two subworkflows.

Prepare the data for the analysis

Note

You can skip to the next section if you want to start the workflow from already prepared files!

  1. Download the raw output files from the workflow using the "Download all" button: https://doi.org/10.5281/zenodo.14974869
  2. Uncompress the zip archive within your project
  3. Create a data_benchmark folder within your project.
  4. Move all the zip files downloaded from zenodo (benchmark-gtdb-f__*.zip) to data_benchmark.
  5. Ensure the two csv files are at the root of your project.
  6. Run the workflow with the following command:
Sys.setenv(TAR_PROJECT = "prepare_pocpbenchmark_data")
targets::tar_make()

Analyze the data and build the manuscript

If you skipped the first workflow, you need to download the cleaned and formatted POCP/POCPu values and metadata tables for analysis from https://doi.org/10.5281/zenodo.14975029. These are the files you would have generated with the previous section.

  1. Run the workflow with the following command:
Sys.setenv(TAR_PROJECT = "analyze_pocpbenchmark_data")
targets::tar_make()

The manuscript is then available in the _manuscript folder, both as a HTML document (index.html) and a docx document. The figures are generated in the figures folder.

About

Code and manuscript for benchmarking proteins alignment tools for improved genus delineation using the Percentage Of Conserved Proteins (POCP)

Resources

License

Stars

Watchers

Forks

Packages

No packages published