Benjamin-Lee / Benjamin-Lee/CodonAdaptationIndex

Documentation Request for Using RSCU param with `python_codon_tables`

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
38
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Just like it sounds. It'd be great to see how to use the RSCU param in the docs. In particular how to integrate it with the value from `python_codon_tables.get_codons_table()`.

Most of the examples are using a reference genome and I get key errors when I try:

```
RSCU = python_codon_tables.get_codons_table("h_sapiens")
initial_grade = CAI.CAI(initial_seq, RSCUs=RSCU)
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing examples that use a reference genome and inspect the `python_codon_tables.get_codons_table()` and `CAI.CAI(..., RSCUs=...)` entry points. Update the documentation with a working integration example and verify that it addresses the reported key errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
bioinformatics, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.