filterx 0.3.3

A command line tool to filter data by using python-like syntax
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


## filterx

<p align="center">
<img src="./docs/docs/public/filterx-icon.png" width="100" height="100" alt="filterx logo">
</p>

<p align="center">

[![pypi](https://github.com/dwpeng/filterx/actions/workflows/release-pypi.yml/badge.svg)](https://github.com/dwpeng/filterx/actions/workflows/release-pypi.yml) [![Github Release](https://github.com/dwpeng/filterx/actions/workflows/release.yml/badge.svg)](https://github.com/dwpeng/filterx/actions/workflows/release.yml)  ![PyPI Downloads](https://static.pepy.tech/badge/filterx)

</p>

A fast command-line tool to filter lines by column-based expression.


## Features
- 🚀 Filter lines by column-based expression
- 🎨 Support multiple input formats e.g. vcf/sam/fasta/fastq/gff/bed/csv/tsv
- 🎉 Cross-platform support
- 📦 Easy to install
- 📚 Rich documentations

## Installation

Using pip or cargo to install `filterx`:

```bash
pip install filterx
```

```bash
cargo install filterx
```

Download the latest release from [releases](https://github.com/dwpeng/filterx/releases).


## Quick Start

<details>
<summary>example.csv</summary>

```csv
id,name,city,phone,gender
1,Alice,New York,123456,F
2,Bob,Los Angeles,234567,M
3,Charlie,Chicago,345678,M
4,David,Houston,456789,M
5,Eve,Phoenix,567890,F
6,Frank,Philadelphia,678901,M
7,Grace,San Antonio,789012,F
8,Heidi,San Diego,890123,F
9,Ivan,Dallas,901234,M
10,Judy,San Jose,012345,F
11,Kevin,New York,123456,M
12,Linda,Los Angeles,234567,F
13,Michael,Chicago,345678,M
14,Nancy,Houston,456789,F
15,Oliver,Phoenix,567890,M
```
</details>

```bash
filterx c example.csv -e "city in ('New York', 'Los Angeles')" -e "gender == 'F'" -e "select(name, id)"
```

Output:

```csv
name,id
Alice,1
Linda,12
```

## Documentation

filterx has a built-in help system, you can use `filterx info --list` to list all available built-in functions, and use `filterx info <command>` to get help for a specific function.


## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=dwpeng/filterx&type=Date)](https://star-history.com/#dwpeng/filterx&Date)