@@ -18,6 +18,8 @@ gem install youplot
1818
1919## Quick Start
2020
21+ ` cat data.tsv | uplot <command> [options] `
22+
2123### barplot
2224
2325``` sh
@@ -103,9 +105,38 @@ cat gencode.v35.annotation.gff3 | grep -v '#' | grep 'gene' | cut -f1 \
103105| uplot bar -d ' ' -t " The number of human gene annotations per chromosome" -c blue
104106```
105107
106- ##
108+ ## Usage
109+
110+ ### Why YouPlot?
111+
112+ Wouldn't it be a bit of pain to have to run R, Python, Julia, gnuplot or whatever REPL just to check your data?
113+ YouPlot is a command line tool for this purpose. With YouPlot, you can continue working without leaving your terminal and shell.
114+
115+ ### how to use YouPlot?
116+
117+ ` uplot ` is the shortened form of ` youplot ` . You can use either.
118+
119+ | | |
120+ | -----------------------------------| ------------------------------------------------|
121+ | Reads data from standard input | ` cat data.tsv \| uplot <command> [options] ` |
122+ | Reads data from files | ` uplot <command> [options] data.tsv ... ` |
123+ | Outputs data from stdin to stdout | ` pipeline1 \| uplot <command> -O \| pipeline2 ` |
124+
125+ ### Where to output the plot?
107126
108- | command | short | |
127+ By default, the plot is output to * standard error output* .
128+ The output file or stream for the plot can be specified with the ` -o ` option.
129+
130+ ### Where to output the input data?
131+
132+ By default, the input data is not output anywhere.
133+ The ` -O ` option, with no arguments, outputs the input data directly to the standard output. This is useful when passing data to a subsequent pipeline.
134+
135+ ### What types of plots are available?
136+
137+ The following sub-commands are available
138+
139+ | command | short | how it works |
109140| -----------| -------| ----------------------------------------|
110141| barplot | bar | draw a horizontal barplot |
111142| histogram | hist | draw a horizontal histogram |
@@ -115,8 +146,13 @@ cat gencode.v35.annotation.gff3 | grep -v '#' | grep 'gene' | cut -f1 \
115146| density | d | draw a density plot |
116147| boxplot | box | draw a horizontal boxplot |
117148
149+ See Quick Start for ` count ` .
150+
151+ | command | short | how it works |
152+ | -----------| -------| ----------------------------------------------------------|
153+ | count | c | draw a baplot based on the number of occurrences (slow) |
118154
119- ### help
155+ ### How to view detailed command line options
120156
121157Use ` --help ` to print command-specific options.
122158
@@ -134,13 +170,21 @@ Options:
134170...
135171```
136172
137- ### colors
173+ ### How to view the list of available colors?
138174
139175``` sh
140176uplot colors
141177```
142178
143- ## Development
179+ ## Contributing
180+
181+ * [ Report bugs] ( https://github.com/kojix2/youplot/issues )
182+ * Fix bugs and [ submit pull requests] ( https://github.com/kojix2/youplot/pulls )
183+ * Write, clarify, or fix documentation
184+ * Suggest or add new features
185+
186+
187+ ### Development
144188
145189``` sh
146190git clone https://github.com/your_name/GR.rb # Clone the Git repo
@@ -150,13 +194,6 @@ bundle exec rake test # Run the test
150194bundle exec rake install # Installation from source code
151195```
152196
153- ## Contributing
154-
155- * [ Report bugs] ( https://github.com/kojix2/youplot/issues )
156- * Fix bugs and [ submit pull requests] ( https://github.com/kojix2/youplot/pulls )
157- * Write, clarify, or fix documentation
158- * Suggest or add new features
159-
160197## License
161198
162199[ MIT License] ( https://opensource.org/licenses/MIT ) .
0 commit comments