jakobnissen / alen Goto Github PK

View Code? Open in Web Editor NEW

76.0 6.0 4.0 409 KB

Simple terminal alignment viewer

License: MIT License

Rust 100.00%

alen's Introduction

Alen

Simple terminal sequence alignment viewer.

What is Alen?

It's a command-line program to view DNA or protein alignments in FASTA formats. Alen is meant for having a quick view of an alignment without having to leave the shell. It's not an alignment editor.

How to install and run.

Alen should work on most Unix systems, and Windows 10. If someone asks me to, I might add Windows 7 and 8 support.

The easiest way to get it is to download the latest release from the releases page (binaries are not yet available for Windows).

Alternatively, you can download the source code from this repo and compile it yourself using cargo build --release.

How to use

Simple usage:

$ alen /path/to/alignment.fasta

Note that Alen loads in the entire alignment into memory, so don't use it for multi-gigabyte files. Alen will auto-detect whether the alignment is a nucleotide or amino acid. For more help, type alen --help in the terminal.

Commands

Esc / q / Ctrl-C: Quit
c: Toggle consensus sequence comparison
r: Re-render the screen.
Ctrl-f: Find. Searches headers, then sequences for regex, case insensitively.
Ctrl-j: Jump to column.
Ctrl-s: Select rows and move them around.
Arrow keys: Move 1 column/row
Shift-Arrow keys: Move 10 columns/rows
Ctrl-Arrow keys: Move to first/last column/row

Configuration

No.

Why the name?

First, it's to pun on the unimaginative named alan and alv. Second, alen means cubit in Danish. Like using cubits, Alen is simple, crude, but usually good enough.

alen's People

Contributors

Stargazers

Watchers

Forkers

bioinformatics-tools-collection marcom cossio jguhlin

alen's Issues

`tmux`-friendly controls?

Hi Jakob! This thing looks cool, thanks!

I recognize that it might not be a common usecase for alen, but I would routinely use it to browse alignments in an ssh session through tmux on macOS. Taken together, it superseeds most of the control key sequences that seem to be hardcoded in alen 😞 specifically, Ctrl-Shift-arrows do not work and ctrl-J jumps to the next pane...

It would be helpful to me if the key bindings were remappable! Otherwise, an alternative control scheme involving less ctrls and shifts would also work.

Cheers,
Nikita

modified RNA residues not working correctly

Hi,
i wanted to say thank you for making this alignment viewer, i really like it!

I have had some problems viewing MSAs of RNAs with modified residues.
The problem seems to be that with all the modified RNA residues that exist, the sequences contain a lot of unusual characters.

A database of modified RNA residues can be found here:
https://iimcb.genesilico.pl/modomics/modifications

There seem to be two problems as far as i can see

unicode characters, e.g. °

>tdbR00000266|Bos_taurus|9913|Leu|°AA
-GUCAGLAUGLCMGAGU--GGDCPAAGGCLCCAGACU°AAKPPCUGGJ-CPCC---GUAU----GGAGG-?GUGGGTPCG"AUCCCACUUCUGACACCA

Error message:

ERROR when loading FASTA: Not all input sequences are the same length. Expected sequence length 99, seq "tdbR00000266|Bos_taurus|9913|Leu|°AA" has length 100.

autodetection trying to interpret sequences as amino-acids

>tdbR00000270|Avian_myeloblastosis_virus|11866|Met|BAU
-GCCUCCUUALCGCAGDA-GGN--AGCGCRPCAGPCUBAU6APCUGAAG-------------------7D??UGAGTPCG"ACCUCAGAGGGGGCACCA

Error message:

ERROR when loading FASTA: Sequence "tdbR00000270|Avian_myeloblastosis_virus|11866|Met|BAU" cannot be understood as amino acids.

My suggestion would be to have additional command-line options to

allow unicode
force dna, rna, aa mode without autodetect

Not sure how to deal with it in visualisation. I guess one color for any nonstandard RNA base would be ok.

What do you think? I could try and make the changes if you agree

Data source:

Data was downloaded from tRNAdb:

http://trna.bioinf.uni-leipzig.de/DataOutput/Search

On the Search Database page, choose tRNA sequences and then press the search database button. This will return RNA sequences with modified sequences. You can save them by selecting the select all sequences of search checkbox on the search results page, and then saving the sequences by choosing Download alignment in the drop down button next to the checkbox.

Alignment::calculate_order should operate on original_index of entries

Currently it operates on the current index of entries, not the original index.
This causes mis-sorting if the input sequences were already permuted before the order is calculated.

Implement CI with GitHub Actions

Steps

PR job which runs a build, rustfmt, and clippy
Master build job with status badge in README.md
New release job, which builds a Changelog from commit history and opens a draft release
New release job attaches pre-built binaries for Linux
New release job attaches pre-built binaries for MacOS (x86_64)

I'm a big believer that every open source project destined for success must make contributions (and maintenance) easy. A solid CI is a cornerstone of that.

If you can spare a week or two, I'd offer to do this for you.

Work with stdin

It would be nice to work with stdin, but unfortunately, crossterm does not seem to support it at the moment.

As soon as crossterm fixes the issue or provide a workaround, implement reading from stdin.

Installation info for newbies

Hi Jakob,

I am missing information on how to install alen. I have downloaded to compressed file to my download folder (I am running Windows subsystem for Linux) and uncompressed it. So, where do I put the files then?

Best,
Rikki