ssb_tbmd_apis.imports package

ssb_tbmd_apis.imports.datadok_meta module

datadok_vars_dataframe_by_path(path)

Read datadok file and convert it to a pandas DataFrame.

Parameters:

path (Path) – Path to the datadok file.

Returns:

DataFrame containing the datadok variables.

Return type:

pd.DataFrame

ssb_tbmd_apis.imports.datadok_open_flatfile module

datadok_open_flatfile_from_path(path, ddok_path=None, **read_fwf_params)

Open a flat file from Datadok and convert it to a pandas DataFrame.

Parameters:
  • path (Path) – Path to the flat file.

  • ddok_path (Path | None) – Path to the Datadok file (optional).

  • read_fwf_params (Any) – Additional parameters for reading the flat file.

Returns:

DataFrame containing the data from the flat file.

Return type:

pd.DataFrame

ssb_tbmd_apis.imports.dtype_mapping module

dtypes_datadok_to_pandas(ddok_var_df)

Map Datadok variable types to pandas dtypes.

Parameters:

ddok_var_df (DataFrame) – DataFrame containing Datadok variable information.

Returns:

Dictionary mapping variable names to pandas dtypes.

Return type:

dict[str, str]

Raises:

NotImplementedError – If an unsupported datatype is encountered.

intwidth_to_pandas_dtype(precision)

Convert integer width to pandas dtype.

Parameters:

precision (int) – Integer width.

Returns:

Corresponding pandas dtype.

Return type:

str

Raises:

ValueError – If precision is too large for pandas Int types.