hotstepper.Steps.read_dataframe

classmethod Steps.read_dataframe(data, start=None, end=None, weight=None, use_datetime=False, convert_delta=False)

Read a Pandas dataframe with values that represent either the cummulative value of the data steps or the direct step values seperately.

Parameters
  • data (Pandas.DataFrame) – A dataframe representing the data to convert to steps.

  • start (str, Optional) – The name of the column containing the start data.

  • end (str, Optional) – The name of the column containing the end data.

  • weight (str, Optional) – The name of the column containg the step weight data, if this is not provided, a value of 1 will be assigned for each row entry.

  • use_datetime (bool, Optional) – Assume start and end fields are of datetime format (Numpy.datetime64,datetime or Pandas.Timestamp).

  • convert_delta (bool, Optional) – Assume weight values are individual step weights (default), or convert values by performing a delta between adjacent values. The data is assumed to be sorted by the provided start values.

Returns

Return type

Steps

See also

read_array, read_dict