zhangyiss/YouPlot
1
0
Fork 0
mirror of https://github.com/red-data-tools/YouPlot.git synced 2025-05-07 15:41:12 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
kojix2 2020-12-16 18:48:34 +09:00 committed by GitHub
commit 6f5b73887d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 51 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -18,6 +18,8 @@ gem install youplot
## Quick Start ## Quick Start
`cat data.tsv | uplot <command> [options]`
### barplot ### barplot
```sh ```sh
@ -103,9 +105,38 @@ cat gencode.v35.annotation.gff3 | grep -v '#' | grep 'gene' | cut -f1 \
| uplot bar -d ' ' -t "The number of human gene annotations per chromosome" -c blue | uplot bar -d ' ' -t "The number of human gene annotations per chromosome" -c blue
``` ```
## ## Usage
| command | short | | ### Why YouPlot?
Wouldn't it be a bit of pain to have to run R, Python, Julia, gnuplot or whatever REPL just to check your data?
YouPlot is a command line tool for this purpose. With YouPlot, you can continue working without leaving your terminal and shell.
### how to use YouPlot?
`uplot` is the shortened form of `youplot`. You can use either.
| | |
|-----------------------------------|------------------------------------------------|
| Reads data from standard input | `cat data.tsv \| uplot <command> [options]` |
| Reads data from files | `uplot <command> [options] data.tsv ...` |
| Outputs data from stdin to stdout | `pipeline1 \| uplot <command> -O \| pipeline2` |
### Where to output the plot?
By default, the plot is output to *standard error output*.
The output file or stream for the plot can be specified with the `-o` option.
### Where to output the input data?
By default, the input data is not output anywhere.
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.
### What types of plots are available?
The following sub-commands are available
| command | short | how it works |
|-----------|-------|----------------------------------------| |-----------|-------|----------------------------------------|
| barplot | bar | draw a horizontal barplot | | barplot | bar | draw a horizontal barplot |
| histogram | hist | draw a horizontal histogram | | histogram | hist | draw a horizontal histogram |
@ -115,8 +146,13 @@ cat gencode.v35.annotation.gff3 | grep -v '#' | grep 'gene' | cut -f1 \
| density | d | draw a density plot | | density | d | draw a density plot |
| boxplot | box | draw a horizontal boxplot | | boxplot | box | draw a horizontal boxplot |
See Quick Start for `count`.
### help | command | short | how it works |
|-----------|-------|----------------------------------------------------------|
| count | c | draw a baplot based on the number of occurrences (slow) |
### How to view detailed command line options
Use `--help` to print command-specific options. Use `--help` to print command-specific options.
@ -134,22 +170,12 @@ Options:
... ...
``` ```
### colors ### How to view the list of available colors?
```sh ```sh
uplot colors uplot colors
``` ```
## Development
```sh
git clone https://github.com/your_name/GR.rb # Clone the Git repo
cd GR.rb
bundle install # Install the gem dependencies
bundle exec rake test # Run the test
bundle exec rake install # Installation from source code
```
## Contributing ## Contributing
* [Report bugs](https://github.com/kojix2/youplot/issues) * [Report bugs](https://github.com/kojix2/youplot/issues)
@ -157,6 +183,17 @@ bundle exec rake install # Installation from source code
* Write, clarify, or fix documentation * Write, clarify, or fix documentation
* Suggest or add new features * Suggest or add new features
### Development
```sh
git clone https://github.com/your_name/GR.rb # Clone the Git repo
cd GR.rb
bundle install # Install the gem dependencies
bundle exec rake test # Run the test
bundle exec rake install # Installation from source code
```
## License ## License
[MIT License](https://opensource.org/licenses/MIT). [MIT License](https://opensource.org/licenses/MIT).