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

Update README and cleanup top-level cli help text #81

Merged
merged 1 commit into from
Feb 4, 2014
Merged

Conversation

massie
Copy link
Member

@massie massie commented Feb 4, 2014

No description provided.

@AmplabJenkins
Copy link

All automated tests passed.
Refer to this link for build results: https://amplab.cs.berkeley.edu/jenkins/job/ADAM-prb/80/

transform : Apply one of more transforms to an ADAM file and save the results to another ADAM file
flagstat : Prints statistics for ADAM data similar to samtools flagstat
transform : Convert SAM/BAM to ADAM format and optionally perform read pre-processing transformations
flagstat : Print statistics on reads in an ADAM file (similar to samtools flagstat)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that we're going to underscores as a word delimiter. In that case, shouldn't this become flag_stat?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Underscore is being used as the delimiter instead of camel case.

I'm not sure that we need to split up all commands especially the shorter ones. Some commands will be useful primarily in scripts whereas commands like listdict and flagstat will more likely be used from the commandline to inspect data. Requiring users to type the underscore will be a bit of a nuisance.

fnothaft added a commit that referenced this pull request Feb 4, 2014
Update README and cleanup top-level cli help text
@fnothaft fnothaft merged commit d8d8901 into master Feb 4, 2014
@fnothaft fnothaft deleted the matt-cleanup branch February 4, 2014 18:34
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

Successfully merging this pull request may close these issues.

3 participants