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

Missing documentation and examples throughout #91

Open
jasondk opened this issue Mar 25, 2024 · 1 comment
Open

Missing documentation and examples throughout #91

jasondk opened this issue Mar 25, 2024 · 1 comment
Assignees
Labels
help wanted Extra attention is needed priority

Comments

@jasondk
Copy link
Member

jasondk commented Mar 25, 2024

Things that are missing:

  • an example codon_stationary_distribution file, and an example aa_fitness_distribution (In general, if there is an option to use a file, we must have an example and a description of the expected format of the file)
  • instructions for the user to install all python3 and R dependencies
  • some example command-lines to run in the README
@jasondk jasondk added the help wanted Extra attention is needed label Mar 25, 2024
@jasondk
Copy link
Member Author

jasondk commented Mar 25, 2024

  • Also, when trying to do a single locus simuation (-g 1 codon) - an error is generated saying that the genome length must be the same as the number of fitness profiles given. Since I was forced to give a minimum of 2 fitness profiles, i am forced to have a minimum genome size of 2 codons. Should allow the user to do a 1 codon genome
    Error message: Please ensure that when using a fasta file, the same number of fitness profiles are provided as the length of the genome in the fasta file. Exiting.
  • In the help system, it says the starting sequence file should be in amino-acids. When this is provided, an error is generated saying that nucleotides are required

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed priority
Projects
None yet
Development

No branches or pull requests

3 participants