milaboratory/docs

Documentation of the old versions

Opened this issue · 3 comments

Hello. Thanks for the great work on documenting MiXCR ! I believe it's not an easy task with all the parameters and options for each functions and presets !

One question though. I wonder if it's possible to keep the documentations for the old versions somewhere accessible ? Recently, there are a lot of new versions and changes, I hope I could check what is available in the version we are using so that we could write the commands accordingly.

In order to be consistent in each project, we try to use the same version. However, like recently, we found some new presets, for example rnaseq-full-length, written inside the documentation but not present in the version we were using, 4.1.0, which made things slightly complicated on our side.

Hi, thank you for the kind words. We do plan to add versions in the near future. Things like presets are under active development right now so the naming changes sometimes.
As for your question regarding rnaseq-full-length preset. Only the name changed because under the hood rnaseq-tcr-full-length and rnaseq-bcr-full-length (which are present in 4.1) are actually identical thus we changed the name to rnaseq-full-length in v4.1.1.

Thanks for the quick reply ! It's good to know that adding versions is in the roadmap !

@michaeleekk You can find MiXCR v3 documentation archived at the Internet Archive Wayback Machine:
https://web.archive.org/web/20220801000000*/mixcr.readthedocs.io/en/master/index.html

p.s. Thanks, MiXCR team, for your great work on the MiXCR software and documentation!