.. _auto_study_get_parameter_response_dataset:

*STUDY PARAMETER & RESPONSE DATASET*
====================================

Creates a tabular dataset from simulation parameters and/or responses belonging to a d3VIEW study, where each row represents one simulation identified by sim_id. Supports flexible missing-data strategies, optional in_/out_ column prefixes, and scalar extraction from curve/vector responses via configurable lookup methods.

When to use
-----------

Tagged: ``curve_lookup``, ``dataset``, ``design_exploration``, ``doe``, ``dyna_keyword``, ``missing_data``, ``parameter_extraction``, ``parameters``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Study
     - study_id
     - remote_lookup
     - —
     - ✓
     - Numeric or string ID of the d3VIEW study whose simulations will be queried; required — the worker errors immediately if omitted.
   * - Response Template
     - response_template_id
     - remote_lookup
     - —
     - ✓
     - ID of the response template used to extract response KPIs; required when Include Data is 'Responses' or 'Both', ignored when 'Parameters' only.
   * - Include Data
     - include_data
     - select
     - Both
     - 
     - Selects which data columns to include in the output: 'Parameters' (input deck values only), 'Responses' (template KPIs only), or 'Both' (default); leave default to get the full parameter–response matrix.
   * - Prefix Column Names
     - prefix_column_names
     - select
     - no
     - 
     - When set to 'yes', parameter columns are prefixed with 'in_' and response columns with 'out_', making input/output separation explicit for downstream ML workers; default is 'no' (no prefix).
   * - Curve Lookup Type
     - curve_lookup_type
     - select
     - ymax
     - 
     - Scalar extraction method applied to curve/vector responses (e.g., 'ymax', 'ymin', 'integral', 'slope'); default is 'ymax' (peak Y value) — change when a different feature of the time-history is the relevant KPI.
   * - Missing Data Strategy
     - missing_data_strategy
     - select
     - Intelligent
     - 
     - Strategy for handling simulations with missing parameter or response values: 'Intelligent' (auto-decide per column), 'Exclude Row' (drop any sim with a missing value), or 'Exclude Column' (drop any column with missing values); default is 'Intelligent'.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Dataset
     - dataset
     - dataset
     - Tabular dataset where each row is one simulation; columns are sim_id followed by parameter columns (optionally prefixed 'in_') and/or response columns (optionally prefixed 'out_'), with missing values handled per the chosen strategy.
   * - Status
     - status
     - text
     - JSON object containing a success flag, a human-readable message, extraction counts, and a list of any rows/columns excluded or duplicate parameters skipped due to multi-file conflicts.

Disciplines
-----------

- cae.postprocessing.extraction
- cae.postprocessing.response
- data.dataset.ingest
- data.dataset.transform
- design_exploration.doe

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>study_get_parameter_response_dataset</code>. Schema hash: <code>2f2d030c1377</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>