Arranger

Arranger is a versatile, model-agnostic data discovery API for OpenSearch and Elasticsearch, designed to simplify building search interfaces for complex datasets. A React component library is included for building interactive search UIs.

Arranger is part of Overture, a collection of open-source software microservices used to create platforms for researchers to organize and share genomics data.

Documentation

Technical resources for those working with or contributing to the project live in the /docs folder of this repository, and are also published, fully rendered, on our official documentation site.

• Arranger Overview
• Setting up the Development Environment
• Reference Docs

Development Environment

• Node.js (v22 or higher)
• Docker (v4.39.0 or higher)
• OpenSearch 1.x or higher, or Elasticsearch 7.x

Note: For Elasticsearch, only the default (licensed) distribution is supported; the discontinued ES OSS distribution is not. Elasticsearch 8.x is not yet supported, and the bundled client is @elastic/elasticsearch v7.

Support & Contributions

• For support, feature requests, and bug reports, please see our Support Guide.
• For detailed information on how to contribute to this project, please see our Contributing Guide.

Related Software

The Overture platform includes the following components:

Software	Description
Score	Transfer data to and from any cloud-based storage system
Song	Catalogue and manage metadata associated to file data spread across cloud storage systems
Maestro	Organizing your distributed data into a centralized Elasticsearch index
Arranger	A search API with reusable UI components
Stage	A React-based web portal scaffolding
Lyric	A model-agnostic, tabular data submission system
Lectern	Schema Manager, designed to validate, store, and manage collections of data dictionaries.

Funding Acknowledgement

Overture is supported by grant #U24CA253529 from the National Cancer Institute at the US National Institutes of Health, and additional funding from Genome Canada, the Canada Foundation for Innovation, the Canadian Institutes of Health Research, Canarie, and the Ontario Institute for Cancer Research.