uvex_transients.surveys.base.SurveySchedule.with_phase

SurveySchedule.with_phase(phase: str) → SurveySchedule

Return a copy of this schedule with every row labeled by phase.

Sets (or overwrites) the optional "phase" column so that, once this schedule has been combined with another via __add__(), rows can be told apart by which input schedule they came from – e.g. to sort or group the combined table by phase.

Parameters:

phase (str) – Label to assign to every row.

Returns:

A new schedule, of type(self), identical to this one except for its "phase" column.

Return type:

SurveySchedule