fafbseg.flywire.get_cave_table

fafbseg.flywire.get_cave_table(table_name, materialization='latest', split_positions=False, fill_user_info=True, drop_invalid=True, *, dataset=None, **filters)[source]

Get annotations from given CAVE table.

Parameters:

  • table_name (str) – Name of the table.

  • materialization ("live" | "latest" | int | bool | iterable) – Which materialization version to fetch. You can also provide an ID (int) for a specific materialization version (see get_materialization_versions). If you provide a container of materialization versions this function will search all of them and concatenate the results (no deduplication). Set to False to fetch the non-materialized version.

  • fill_user_info (bool | full) – Whether to fill in user information for the table. Only relevant if table has a user_id column. If True, will add a user_name column. If “full”, will add also add a user_pi column.

  • split_positions (bool) – Whether to split x/y/z positions into separate columns.

  • drop_invalid (bool) – Whether to drop invalidated (i.e. deleted or updated) annotations.

  • dataset ("public" | "production" | "sandbox" | "flat_630", optional) – Against which FlyWire dataset to query. If None will fall back to the default dataset (see set_default_dataset()).

  • **filters – Additional filter queries. See Examples. This works only if materialization!=False.

Returns:

table

Return type:

pandas.DataFrame