Skip to content

Document operation parameter value in check_parameter reference #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
RakeshBobba03 wants to merge 2 commits into from
Closed

Document operation parameter value in check_parameter reference #293

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47913dc
Document operation parameter `value` in check_parameter reference
RakeshBobba03 Feb 20, 2026
fab6bd0
docs: document subtract parameter for minus operation (replace value)
RakeshBobba03 Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/check_parameter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,16 @@ Terminology term value used in controlled terminology operations for value-based
### version
Version parameter used in codelist operations that require version-specific processing or validation.

### subtract
Reference to another operation result, used as the second operand in operations that take two inputs. For example, in the `minus` operation, `name` references the minuend (first list) and `subtract` references the subtrahend (second list); the operation returns elements in the first list that are not in the second.

```yaml
- id: $expected_minus_dataset
name: $expected_variables
operator: minus
subtract: $dataset_variables
```

### within
Specifies the column name used for grouping data before applying validation rules. In the rules engine implementation, this parameter is processed through `replace_prefix()` and used in `groupby()` operations to ensure validation logic is applied within appropriate data boundaries (e.g., by subject, by study).

Expand Down
Loading