VARGRAM

[cjpalpallatoc]

Submitting Author: C. J. Palpal-latoc (@cjpalpallatoc)
Package Name: VARGRAM
One-Line Description of Package: A Python visualization tool for genomic surveillance
Repository Link (if existing): https://github.com/pgcbioinfo/vargram
EiC: TBD

---

Code of Conduct & Commitment to Maintain Package

• I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package after should it be accepted.
• I have read and will commit to package maintenance after the review as per the pyOpenSci Policies Guidelines.

Description

• Include a brief paragraph describing what your package does:

During a viral outbreak, the diversity of sampled sequences often needs to be quickly determined to understand the evolution of a pathogen. VARGRAM (Visual ARrays for GRaphical Analysis of Mutations) empowers researchers to quickly generate a mutation profile to compare batches of sequences against each other and against a reference set of mutations. A publication-ready profile can be generated in a couple lines of code by providing sequence files (FASTA, GFF3) or tabular data (CSV, TSV, Pandas DataFrame). When sequence files are provided, VARGRAM leverages Nextclade CLI to perform mutation calling. We have user-friendly installation instructions and tutorials on our documentation website.

Community Partnerships

We partner with communities to support peer review with an additional layer of
checks that satisfy community requirements. If your package fits into an
existing community please check below:

• Astropy: My package adheres to Astropy community standards
• Pangeo: My package adheres to the Pangeo standards listed in the pyOpenSci peer review guidebook

Scope

• Please indicate which category or categories this package falls under:

  • Data retrieval
  • Data extraction
  • Data processing/munging
  • Data deposition
  • Data validation and testing
  • Data visualization
  • Workflow automation
  • Citation management and bibliometrics
  • Scientific software wrappers
  • Database interoperability

Domain Specific

• Geospatial
• Education

---

• Explain how and why the package falls under these categories (briefly, 1-2 sentences). For community partnerships, check also their specific guidelines as documented in the links above. Please note any areas you are unsure of:
  VARGRAM falls under data processing as the user-provided input cannot be plotted immediately. When sequence files are provided, an external tool (Nextclade) will also be called and its output needs to be transformed. It falls under data visualization as the main output is a figure which provides insights not accessible by reading the input alone.

• Who is the target audience and what are the scientific applications of this package?
  We hope that VARGRAM would be useful for researchers, analysts, and students in the field of molecular epidemiology/genomic surveillance. During the pandemic, we've used an early mutation profile script to characterize emergent variants and potential recombinants.

• Are there other Python packages that accomplish similar things? If so, how does yours differ?
  There's no Python package that we are aware of that is similar to VARGRAM which is also how we've come to create the package in the first place. There are packages like Marsilea that can in principle be used to make a profile, but these are more general in scope and would require more work for the user than if they used VARGRAM. Outside Python, we've seen researchers create mutation profiles with custom scripts (in R) and there are also web tools available like Nextclade. VARGRAM differs by making the process substantially convenient in terms of generation and customization of the figure.

• Any other questions or issues we should be aware of:
  We envision VARGRAM to be a visualization library for common use cases in genomic surveillance. In the coming months, we hope to gradually add more features. But rather than wait for all those features to be include, we believe that we can benefit more from the pyOpenSci community if we submit now while the package is young (but already useful).

P.S. Have feedback/comments about our review process? Leave a comment here