petab.v1.mapping

Functionality related to the PEtab entity mapping table

Functions

check_mapping_df(df[, model])

Run sanity checks on PEtab mapping table

get_mapping_df(mapping_file)

Read the provided mapping file into a pandas.Dataframe.

resolve_mapping(mapping_df, element)

Resolve mapping for a given element.

write_mapping_df(df, filename)

Write PEtab mapping table
petab.v1.mapping.check_mapping_df(df: DataFrame, model: Model | None = None) → None[source]

Run sanity checks on PEtab mapping table

Parameters:

  • df – PEtab mapping DataFrame

  • model – Model for additional checking of parameter IDs

Raises:

AssertionError – in case of problems

petab.v1.mapping.get_mapping_df(mapping_file: None | str | Path | DataFrame) → DataFrame[source]

Read the provided mapping file into a pandas.Dataframe.

Parameters:

mapping_file – Name of file to read from or pandas.Dataframe

Returns:

Mapping DataFrame

petab.v1.mapping.resolve_mapping(mapping_df: DataFrame | None, element: str) → str[source]

Resolve mapping for a given element.

Parameters:

  • element – Element to resolve.

  • mapping_df – Mapping table.

Returns:

Resolved element.

petab.v1.mapping.write_mapping_df(df: DataFrame, filename: str | Path) → None[source]

Write PEtab mapping table

Parameters:

  • df – PEtab mapping table

  • filename – Destination file name