Build JSON endpoints for shields.io to display sample and study annotation counts per source.

EndpointParams dataclass

Storage of shields.io JSON endpoints.

to_json()

Format endpoint parameters to JSON compatible with shields.io.

ShieldEndpointBuilder

Build all endpoints across sources for a given level.

endpoints property

Return endpoints configs.

build()

Build shield.io JSON endpoints to display sample and series annotation source counts.

Returns:
  • EndpointBuilder –

    Return self for chaining.

save(outdir=SOURCE_COUNT_SHIELD_OUTDIR)

Save all built endpoints to a single directory.

get_source_counts()

Get counts for each annotation source in the sample and series MetaHQ databases.