MurtoHilali/vritools

Python package and command line tools for working with variant residues at interfaces and protein data.

VRITools

VRITools is a collection of Python tools designed as a remedy for the most common, small headaches encountered when studying variant residues at Protein-Protein Interactions (PPIs).

Table of Contents

• Installation
• Usage
  • Mutation Code Parser
  • Convert Amino Acids
  • Mutate FASTA
• Contributing
• License
• Acknowledgements

Installation

TODO: Instructions on how to install the package.

Usage

Mutation Code Parser

To use the mutation code parser from the command line:

$ vritools mutation_code -c "G123C" -w

Convert Amino Acids

To convert between three-letter and one-letter amino acid codes:

$ vritools convert [CODE]

Mutate FASTA

To create a mutated version of a FASTA file:

$ vritools mutate_fasta [FASTA_FILE] [MUTATION_CODE] [OUTPUT_FOLDER]

Contributing

TODO: Guidelines for contributing to this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

TODO: Any acknowledgements or credits.