generate design worksheet

functions to generate a design worksheet for an investigation.

friendly_doe.worksheet.add_design_information(exp_design: DoeSchema, design_type: DesignType, runs: int, centerpoints: int = 3, replicates: int = 0, replication_design: int = 0, other_settings: dict[str, Any] | None = None) → DoeSchema

Add design information to experimental design dataclass

this information will be used when generating the worksheet

Parameters:

exp_design: experimental design dataclass design_type: design type enum

runs: number of runs

centerpoints: number of centerpoints

replicates: number of replicates

replication_design: replication design

other_settings: dictionary with other design settings

Returns

updated experimental design dataclass

Example:

>>> design_type = DesignType.FFR_III
>>> runs = 4
>>> centerpoints = 3
>>> replicates = 2

>>> updated_exp_design = add_design_information(
    exp_design,
    design_type,
    runs,
    centerpoints,
    replicates,
)

here updated_exp_design.design.type will be DesignType.FFR_III and updated_exp_design.design.settings will contain the provided settings 4 runs, 3 centerpoints, 2 replicates and 0 replication_design

friendly_doe.worksheet.generate_worksheet_as_dataframe(exp_design: DoeSchema) → tuple[DataFrame, Design]

generate worksheet Parameters

exp_design: experimental design dataclass

Returns

generated worksheet as a pandas.DataFrame and the used design class