BPA-OTU is a web-based portal into Operational Taxonomic Unit (OTU) data, developed to access data from the Australian Microbiome.
- Install docker and compose
- git clone https://github.com/muccg/bpaotu.git
./develop.sh build base
./develop.sh build builder
./develop.sh build dev
develop.sh up
will spin up the stack. See ./develop.sh
for some utility methods, which typically are simple
wrappers arround docker and docker-compose.
BPA-OTU loads input data to generate a PostgreSQL schema named otu
. The importer functionality completely
erases all previously loaded data.
Three categories of file are ingested:
- contextual metadata (XLSX format; data import is provided for Marine Microbes and BASE metadata)
- taxonomy files (extension:
.tax
) - OTU abundance tables (extension:
.otu
)
All files should be placed under a base directory, and then the ingest can be run as a Django management command:
$ docker-compose exec runserver bash
root@420c1d1e9fe4:~# /app/docker-entrypoint.sh django-admin otu_ingest /data/otu/
These files are managed by Bioplatforms Australia. The latest version of these files can be found at the Bioplatforms Australia data portal.
A tab-delimited file with extension '.tax'
The first row of this file is a header, and has the form:
OTU ID\tkingdom\tphylum\tclass\torder\tfamily\tgenus
Each column has the following format:
- OTU ID: a string describing the OTU (GATC string)
- technology: text string (e.g. 16S, A16S, 18S, ITS, ...)
- kingdom: text string
- phylum: text string
- class: text string
- order: text string
- family: text string
- genus: text string
A tab-delimited file with the extension .otu
The first row is a header, with the following format:
- OTU ID: header for OTU ID column
- Sample ID [repeated]: the identifier for the sample ID for which this column specifies abundance
Each following has the following format:
- OTU ID: the OTU ID (text string, corresponding to the strings in the taxonomy file)
- Abundance [repeated]: the abundance (floating point) for the column's sample ID
Ensure a late version of both docker and docker-compose are available in your environment.
bpaotu is available as a fully contained Dockerized stack. The dockerised stack are used for both production and development. Appropiate configuration files are available depending on usage.
Note that for data ingestion to work you need passwords to the hosted data, these are available from BPA on request. Set passwords in your environment, these will be passed to the container.
Bioplatforms Australia - Australian Microbiome Search Facility
Copyright © 2017, Bioplatforms Australia.
BPA OTU is released under the GNU Affero GPL. See source for a licence copy.
- Fork next_release branch
- Make changes on a feature branch
- Submit pull request