Base class for metadata retrieval from OmicIDX.

get_available_tables()

Show available tables in OmicIDX.

get_available_fields(channel_name=OMICIDX_COL_CHANNELS)

Identify the available metadata fields to query.

Parameters:
  • channel_name (str, default: OMICIDX_COL_CHANNELS ) –

    Name of the channels column.
Returns:
  • tuple[list[str], list[str]] –

    All fields available to query and channel specific fields are those are hidden in a struct in the channel_name column.

save(file, null_values=None)

Save metadata to parquet file.

show_available_fields()

Print available fields to logger.

validate()

Validate the retrieved metadata DataFrame.