fnndsc/pl-graph2table
A ChRIS plugin app
1.3K
.. image:: https://img.shields.io/docker/v/fnndsc/pl-graph2table?sort=semver :target: https://hub.docker.com/r/fnndsc/pl-graph2table
.. image:: https://img.shields.io/github/license/fnndsc/pl-graph2table :target: https://github.com/FNNDSC/pl-graph2table/blob/master/LICENSE
.. image:: https://github.com/FNNDSC/pl-graph2table/workflows/ci/badge.svg :target: https://github.com/FNNDSC/pl-graph2table/actions
.. contents:: Table of Contents
An app to ...
graph2table
is a ChRIS ds-type application that takes in ... as ... files
and produces ...
.. code::
docker run --rm fnndsc/pl-graph2table graph2table
[-h|--help]
[--json] [--man] [--meta]
[--savejson <DIR>]
[-v|--verbosity <level>]
[--version]
<inputDir> <outputDir>
Arguments
.. code::
[-h] [--help]
If specified, show help message and exit.
[--json]
If specified, show json representation of app and exit.
[--man]
If specified, print (this) man page and exit.
[--meta]
If specified, print plugin meta data and exit.
[--savejson <DIR>]
If specified, save json representation file to DIR and exit.
[-v <level>] [--verbosity <level>]
Verbosity level for app. Not used currently.
[--version]
If specified, print version number and exit.
Getting inline help is:
.. code:: bash
docker run --rm fnndsc/pl-graph2table graph2table --man
Run
~~~
You need to specify input and output directories using the `-v` flag to `docker run`.
.. code:: bash
docker run --rm -u $(id -u) \
-v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing \
fnndsc/pl-graph2table graph2table \
/incoming /outgoing
Development
-----------
Build the Docker container:
.. code:: bash
docker build -t local/pl-graph2table .
Run unit tests:
.. code:: bash
docker run --rm local/pl-graph2table nosetests
Examples
--------
Put some examples here!
.. image:: https://raw.githubusercontent.com/FNNDSC/cookiecutter-chrisapp/master/doc/assets/badge/light.png
:target: https://chrisstore.co
docker pull fnndsc/pl-graph2table