Flow API Documentation
Flow is software for running Nextflow pipelines, and collating the resultant data into meaningful, well-annotated structures and samples that collectively comprises a rich datatset. While it has a powerful frontend interface, it can also be interacted with directly via its API.
Getting started
To get started, consider first familiarising yourself with the core concepts of Flow, starting with users and groups, and how they relate to one another. It may also be useful to explore the public frontend to get a sense of the available data. Once familiar with Flow, you have the option of interacting with programmatically it via the REST API, GraphQL API, or flowbio Python library.
Resources
Pipelines and Groups
Learn about the pipeline model, how they are organised, and how they are executed.
Data
Learn about the data model, and how Flow handles files.
Samples
Learn about the sample model and how Flow organises related data.
Permissions
Learn about the permissions models, and how Flow limits access to objects based on the user.