Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation mismaches #11

Closed
carleshf opened this issue Dec 2, 2021 · 4 comments
Closed

Documentation mismaches #11

carleshf opened this issue Dec 2, 2021 · 4 comments
Labels

Comments

@carleshf
Copy link

carleshf commented Dec 2, 2021

Describe the bug
Documentation on PyPI and on ReadTheDocs shows different functionally and different usage of the package.

Additional context
I end up here from mutalyzer looking for a systematic way to back-translate proteins to cDNA. As suggested by the text:

The underlying algorithm is also available as a command line utility and programming library (source, package).

@jfjlaros
Copy link
Member

jfjlaros commented Dec 2, 2021

It seems that the link on the Mutalyzer 2 website is outdated, it should point to the current package.

@mihailefter Could you check which version Mutalyzer 2 depends on and whether this link is indeed outdated?

@carleshf
Copy link
Author

carleshf commented Dec 2, 2021

Thanks for the new!

Just a question, is there, then any function to translate from protein format to cDNA format in mutalyzer-backtranslate as it does Back Translator in mutalyzer?

@jfjlaros
Copy link
Member

jfjlaros commented Dec 2, 2021

This is a pure programming library, it has no HGVS support in itself.

It should be relatively straightforward to generate g. or n. descriptions from the output, then the API could be used to convert these descriptions.

@carleshf carleshf closed this as completed Dec 2, 2021
@jfjlaros
Copy link
Member

jfjlaros commented Dec 4, 2021

Just for the record, Mutalyzer 2 uses the old version of the backtranslate package, so the link on the website is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants