Metadata-Version: 2.1
Name: xcltk
Version: 0.1.15
Summary: xcltk - Toolkit for XClone
Home-page: https://github.com/hxj5/xcltk
Author: Xianjie Huang
Author-email: xianjie5@connect.hku.hk
License: Apache-2.0
Keywords: xclone,toolkit
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# xcltk

[![](https://img.shields.io/pypi/v/xcltk.svg)][pypi]
[![](https://img.shields.io/github/license/hxj5/xcltk)][licence]

xcltk is a toolkit for XClone (**warning: under development, not stable**)

All release notes are available at [doc/release.rst][release]

## Installation

xcltk is avaliable through [pypi][pypi]. To install, type the following command 
line, and add `-U` for upgrading:

```shell
pip install -U xcltk
```

Alternatively, you can install from this GitHub repository for latest (often 
development) version by following command line

```shell
pip install -U git+https://github.com/hxj5/xcltk
```

In either case, if you don't have write permission for your current Python environment,
 we suggest creating a separate [conda][conda] environment or add --user for your 
current one.

## Manual

You can check the full parameters with `xcltk -h`.

```
Program: xcltk (Toolkit for XClone)
Version: 0.1.14

Usage:   xcltk <command> [options]

Commands:
  -- BAF calculation
     fixref           Fix REF, ALT and GT
     pileup           Pileup, support unique counting

  -- RDR calculation
     basefc           Basic feature count

  -- Region operations
     convert          Convert different region file formats

  -- Others
     -h, --help       Print this message
     -V, --version    Print version
```

[pypi]: https://pypi.org/project/xcltk
[licence]: https://github.com/hxj5/xcltk
[release]: https://github.com/hxj5/xcltk/blob/master/doc/release.rst
[conda]: https://docs.conda.io/en/latest/



