Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
darwinsorchid authored Aug 30, 2024
1 parent 5396c31 commit 47a756c
Showing 1 changed file with 40 additions and 6 deletions.
46 changes: 40 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,46 @@
* User can choose between calculating total GC content of each sequence or performing sliding window analysis (SWAN) for the calculation of the GC content for each window,
to reveal patterns of variability along nucleotide sequences.

## Outputs
* Single sequence / Simple calculation : Floating point number
* Single sequence / SWAN : Simple line plot
* Multiple sequences / Simple calculation : Barplot
## Sequence input options
- [GC_user_input] DNA/RNA sequences, as well as window and step size in case of sliding window analysis, are passed in via user input.
- [GC_argparse] DNA/RNA sequences, as well as window and step size in case of sliding window analysis, are passed in via the command line: At least one sequence is required as a positional argument,
whereas window and step size are optional arguments.
- [GC_argparse_file] DNA/RNA sequences are parsed from different file formats passed in via the command line as optional arguments. The user can choose between the following file formats:
1. FASTA (.fasta)
2. FASTA nucleid acid (.fna)
3. GenBank (.gb)
4. Aligned FASTA (.fa)
5. ClustalW (.aln)

_**NOTE** : Sliding window analysis option is not available for calculating GC content of sequences from files._

## Expected outputs
[GC_user_input]
* Single sequence / Simple calculation : Floating point number of GC value
* Single sequence / SWAN : Simple line plot of GC values
* Multiple sequences / Simple calculation : Barplot of GC values
* Multiple sequences / SWAN : Line plot with multiple y values

_**NOTE** : Sequences in figures are represented as they are passed in._

[GC_argparse]
* Single sequence / Simple calculation : Barplot of GC value
* Single sequence / SWAN : Simple line plot of GC values
* Multiple sequences / Simple calculation : Barplot of GC values
* Multiple sequences / SWAN : Line plot with multiple y values

_**NOTE** : Sequences in figures are represented as they are passed in._

[GC_argparse_file]
* Single sequence : Barplot of GC value
* Multiple sequences : Barplot of GC values

_**NOTE** : Sequences in figures are represented as their respective accession numbers / species names depending on the file format._

## Libraries
- matplotlib
- biopython
| [GC_user_input] | [GC_argparse] | [GC_argparse_file] |
| --------------- |:-------------:| ------------------:|
| matplotlib | argparse | argparse |
| biopython | matplotlib | matplotlib |
| | biopython | biopython |
| | | sys |

0 comments on commit 47a756c

Please sign in to comment.