README.md

December 27, 2024 ยท View on GitHub

filterx

filterx logo

pypi Github Release PyPI Downloads

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:

pip install filterx
cargo install filterx

Download the latest release from releases.

Quick Start

example.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
filterx c example.csv -e "city in ('New York', 'Los Angeles')" -e "gender == 'F'" -e "select(name, id)"

Output:

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