-
Notifications
You must be signed in to change notification settings - Fork 8
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
Expand readme, clarify inputs, etc. (Enhancement) #2
Comments
Thanks for submitting this issue! You can track the development of a production-level implementation of YACHT here. Feedback is welcome there too. |
PR related to this issue: PR29: the initial readme, Shaopeng by ShaopengLiu1 · Pull Request #29 · KoslickiLab/YACHT |
github-project-automation
bot
moved this from In Progress
to Done
in @dkoslicki's YACHT production level code
Nov 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current behavior
Commands are listed, no access to path
../ForSteve
, no parameters and information are listed in readme - have to look at the code or download and run the help menu.Expected behavior
Have a
Quick start
area with commands and more Indepth information below it. Give link to the--ref_file
being used inref_matrix.py
and use repo path for test data (I should be able to copy your commands and run them on my computer with minimal edits for a "quick start").Add in a more information on running the scripts and their arguments either in the main readme or another markdown file that is linked in the readme. For instance, do my ref files have to be zip or can they be gzip/some other compression, what is
--w
, what are the acceptable ranges, etc.Extra random code update:
Would be nice to update parameters that are one letter to an actual term and the one letter as a short-hand param.. something like:
-w
and--weight
in the argument parser.The text was updated successfully, but these errors were encountered: