qis.load_df_from_excel

qis.load_df_from_excel(file_name, sheet_name='Sheet1', local_path=None, folder_name=None, key=None, is_index=True, delocalize=False, header=0, preserve_header0_columns=True)[source]

read one sheet of an Excel workbook into a DataFrame.

Parameters:

  • file_name (str) – base file name without extension

  • sheet_name (str) – sheet to read

  • local_path (str | None) – directory to read from

  • folder_name (str) – subdirectory under local_path

  • key (str) – suffix appended to file_name

  • is_index (bool) – read the first column as the index

  • delocalize (bool) – drop the timezone from a datetime index. Excel often carries a local timezone that is an artefact of the machine that wrote the file, not of the data

  • header (int) – row number of the header, zero-based

  • preserve_header0_columns (bool) – when header is not 0, keep the names from row 0 as the column labels, so a two-row header does not lose the names in favour of the units

Returns:

the sheet as a frame

Raises:

FileNotFoundError – if the workbook does not exist

Return type:

DataFrame