Skip to content
Snippets Groups Projects
Commit 63af291f authored by Aaron's avatar Aaron
Browse files

[DOCS] update groupby usage

parent 26abedba
No related branches found
No related tags found
No related merge requests found
...@@ -3,10 +3,11 @@ ...@@ -3,10 +3,11 @@
############### ###############
``bedtools groupby`` is a useful tool that mimics the "group by" clause in database ``bedtools groupby`` is a useful tool that mimics the "group by" clause in database
systems. Given a file or stream that is sorted by the appropriate "grouping systems. Given a file or stream that is sorted by the appropriate "grouping
columns", ``groupby`` will compute summary statistics on another column in the columns" (``-g``), ``groupby`` will compute summary statistics on another
file or stream. This will work with output from all BEDTools as well as any other column (``-c``) in the file or stream. This will work with output from all
tab-delimited file or stream. As such, this is a generally useful tool for BEDTools as well as any other tab-delimited file or stream. As such, this is a
all command-line analyses, not just genomics related research. generally useful tool for all command-line analyses, not just genomics related
research.
.. note:: .. note::
When using ``bedtools groupby``, the input data must be ordered by the same When using ``bedtools groupby``, the input data must be ordered by the same
...@@ -24,12 +25,12 @@ all command-line analyses, not just genomics related research. ...@@ -24,12 +25,12 @@ all command-line analyses, not just genomics related research.
Usage Usage
:: ::
bedtools groupby [OPTIONS] -i <input> -c <input column> -o <operation> bedtools groupby [OPTIONS] -i <input> -g <group columns> -c <op. column> -o <operation>
or: or:
:: ::
groupBy [OPTIONS] -i <input> -c <input column> -o <operation> groupBy [OPTIONS] -i <input> -g <group columns> -c <op. column> -o <operation>
=========================== =============================================================================================================================================================================================================== =========================== ===============================================================================================================================================================================================================
Option Description Option Description
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment