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

Expand readme, clarify inputs, etc. (Enhancement) #2

Closed
gregorysprenger opened this issue Apr 24, 2023 · 2 comments
Closed

Expand readme, clarify inputs, etc. (Enhancement) #2

gregorysprenger opened this issue Apr 24, 2023 · 2 comments

Comments

@gregorysprenger
Copy link

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 in ref_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.

@dkoslicki dkoslicki transferred this issue from KoslickiLab/Estimating_Unknowns Apr 27, 2023
@dkoslicki
Copy link
Member

Thanks for submitting this issue! You can track the development of a production-level implementation of YACHT here. Feedback is welcome there too.

@mfl15
Copy link
Contributor

mfl15 commented Nov 9, 2023

PR related to this issue:

PR29: the initial readme, Shaopeng by ShaopengLiu1 · Pull Request #29 · KoslickiLab/YACHT
PR50: one more edit, Shaopeng by ShaopengLiu1 · Pull Request #50 · KoslickiLab/YACHT

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

No branches or pull requests

3 participants