fxsplit 0.0.2

split FASTX into N chunks/files/headers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

<p align="center">
  <p align="center">
    <img width=200 align="center" src="./assets/fxsplit.png" >
  </p>

  <span>
    <h1 align="center">
        fxsplit
    </h1>
  </span>

  <p align="center">
    <a href="https://img.shields.io/badge/version-0.0.1-green" target="_blank">
      <img alt="Version Badge" src="https://img.shields.io/badge/version-0.0.1-green">
    </a>
    <a href="https://crates.io/crates/fxsplit" target="_blank">
      <img alt="Crates.io Version" src="https://img.shields.io/crates/v/fxsplit">
    </a>
    <a href="https://github.com/alejandrogzi/fxsplit" target="_blank">
      <img alt="GitHub License" src="https://img.shields.io/github/license/alejandrogzi/fxsplit?color=blue">
    </a>
    <a href="https://crates.io/crates/fxsplit" target="_blank">
      <img alt="Crates.io Total Downloads" src="https://img.shields.io/crates/d/fxsplit">
    </a>
  </p>


  <p align="center">

  </p>

  <p align="center">
    <samp>
        <span>split FASTX files (plain or gzipped) into smaller chunks/files/headers</span>
        <br>
        <br>
        <a href="https://docs.rs/fxsplit/0.0.1/fxsplit/">docs</a> .
        <a href="https://github.com/alejandrogzi/fxsplit?tab=readme-ov-file#Usage">usage</a> .
        <a href="https://github.com/alejandrogzi/fxsplit?tab=readme-ov-file#Installation">install</a> .
        <a href="https://github.com/alejandrogzi/fxsplit?tab=readme-ov-file#Docker">docker</a>
    </samp>
  </p>
  
</p>

## Split modes

- `--chunks N`: write `N` records per output file.
- `--files K`: write exactly `K` output files with records as evenly distributed as possible.
- `--headers`: FASTA-only mode, one output file per FASTA header using sanitized FASTA IDs as filenames.

`--chunks`, `--files`, and `--headers` are mutually exclusive.

## Install

```bash
cargo install fxsplit
```

## Usage

```bash
fxsplit --help
fxsplit --file input.fasta --chunks 1000 --outdir chunks
fxsplit --file input.fastq.gz --files 8 --outdir parts
fxsplit --file input.fasta.gz --headers --outdir by_header
```

## Docker

Build:

```bash
docker build -t fxsplit:local .
```

Run:

```bash
docker run --rm fxsplit:local fxsplit --help
docker run --rm -v "$PWD:/data" fxsplit:local fxsplit --file /data/input.fasta --chunks 1000 --outdir /data/out
```

Pull:

```bash
docker pull alejandrogzi/fxsplit:latest
```