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 for annotate_maf_triplet #68

Open
rdmorin opened this issue Dec 2, 2024 · 0 comments
Open

Documentation for annotate_maf_triplet #68

rdmorin opened this issue Dec 2, 2024 · 0 comments
Assignees

Comments

@rdmorin
Copy link
Contributor

rdmorin commented Dec 2, 2024

I have some suggestions for how this functions documentation could be improved for clarity and completeness.

  1. pyrimidine_collapse parameter is not explained. It just says "Estimate mutation_strand and"
  2. fastaPath should start by saying what it is e.g. "the path to the genome fasta file corresponding to the genome build"
  3. bsgenome_name: Please provide an actual worked example showing a name instead of just the explanation for how to construct the name.
  4. ref and alt are ignored (I think) when all_SNVs is TRUE but this is not made clear.
  5. projection: what is the purpose of this argument and how does it relate to the fastaPath and bsgenome_name (i.e. does one make the others unnecessary? Please specify so users don't have to figure this out themselves)

I also think the genome reference could be automatically found so is this parameter unnecessarily confusing? Or is that actually done already using the information in the MAF? In any case, the optional arguments need to be clarified so users don't assume that these need to be provided.

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

No branches or pull requests

2 participants