flowbio

A client for the Flow API.


Keywords
nextflow, bioinformatics, pipeline
License
MIT
Install
pip install flowbio==0.3.2

Documentation

flowbio

A client for the Flow API.

import flowbio

client = flowbio.Client()
client.login("your_username", "your_password")

# Upload standard data
data = client.upload_data("/path/to/file.fa", progress=True, retries=5)
print(data)

# Upload sample
sample = client.upload_sample(
    "My Sample Name",
    "/path/to/reads1.fastq.gz",
    "/path/to/reads2.fastq.gz", # optional
    progress=True,
    retries=5,
    metadata={
        "category": "RNA-Seq",
        "strandedness": "unstranded",
    }
)
print(sample)

# Upload lane
lane = client.upload_lane(
    "My Lane Name",
    "/path/to/annotation.xlsx",
    "/path/to/multiplexed.fastq.gz",
    ignore_warnings=True,
    progress=True,
    retries=5
)
print(lane)

# Run pipeline
execution = client.run_pipeline(
    "RNA-Seq",
    "3.8.1",
    "23.04.3",
    params={"param1": "param2"},
    data_params={"fasta": 123456789},
)