Skip to content

guigolab/annotrieve-registry

Repository files navigation

Annotrieve community annotations registry

This repository is the community registry for genome annotation entries that power Annotrieve.

What this repo is for

Contributors add project folders. Each folder contains:

  • A manifest.yaml file — who produced the annotation and how (provider, pipeline, version).
  • An annotations.tsv file — one row per assembly: NCBI accession (GCA_… / GCF_…) and a stable HTTPS link to a GFF3 file (plain or gzipped).

Together, these files describe “this assembly, this annotation file,” in a form that can be checked automatically.

Annotation URLs: Pull-request validation downloads each linked file (up to 500 MiB per URL). Files above that size fail. Gzip-compressed GFF3 (.gff.gz) is strongly recommended — smaller downloads, faster checks, and less chance of exceeding the limit.

Files you add or edit when you contribute

<project_name>/
  manifest.yaml      # Required metadata (see schema)
  annotations.tsv    # Header + one row per assembly (tab-separated)

See CONTRIBUTING.md for a step-by-step flow (fork → edit → pull request).

How it fits in the larger system

After your changes are merged here, the Genome Annotation Tracker reads this registry, turns each project’s manifest + TSV into formatted rows, and adds them to the shared community annotation table. Those rows are published on Annotrieve in periodic imports.

You (this repo)             Downstream                          App
─────────────────           ──────────────────────────────      ───────────
manifest.yaml        ──►    genome-annotation-tracker    ──►    Annotrieve
annotations.tsv              (community TSV)

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors