Skip to content

docs: 🏗️ clarify that request.yaml should be where subset/ is #90

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

Merged
lwjohnst86 merged 5 commits into from
Aug 21, 2026
Merged

docs: 🏗️ clarify that request.yaml should be where subset/ is #90

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3cfa50b
docs: 🏗️ clarify that `request.yaml` should be where `subset/` is
lwjohnst86 Aug 10, 2026
ef5bc0b
Merge branch 'main' into docs/clarify-where-request-and-subset-folder…
lwjohnst86 Aug 13, 2026
93db2c9
Merge branch 'main' into docs/clarify-where-request-and-subset-folder…
lwjohnst86 Aug 17, 2026
b08af60
Merge branch 'main' of https://github.com/seedcase-project/seedcase-p…
lwjohnst86 Aug 21, 2026
c3a4165
docs: ✏️ edits based on reviews
lwjohnst86 Aug 21, 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
20 changes: 11 additions & 9 deletions docs/design/interface/cli.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,15 +125,17 @@ directory, since `subset` is meant to be run by the Owner or data manager while
in the data package folder.

The `SOURCE` argument is the same as the `SOURCE` argument used above for
`build`. The default for `OUTPUT-DIR` is `subsets/`. The final output path is
created from the Requester's project `name` field in the request file and the
resource `name` field(s) of the source file. For example, if the Requester's
project is `diet-diabetes` and the request file asks for two resources,
`resource1` and `resource2`, the output will be:
`build`. The default for `OUTPUT-DIR` is `subset/`. Ideally, the `request.yaml`
file and the `subset/` directory are both in the same directory. By default, the
`subset/` directory will be created in the same directory as the `request.yaml`
file. The final output path is created from the Requester's project `name` field
in the request file and the resource `name` field(s) of the source file. For
example, if the Requester's project is `diet-diabetes` and the request file asks
for two resources, `resource1` and `resource2`, the output will be:

```text
subsets/diet-diabetes/resource1.parquet
subsets/diet-diabetes/resource2.parquet
subset/diet-diabetes/resource1.parquet
subset/diet-diabetes/resource2.parquet
```

The `--show-plan` flag is a boolean that defaults to `false`. If `true`, the CLI
Expand All @@ -157,8 +159,8 @@ flowchart LR
subset["subset"]
request[/"request.yaml<br>[REQUEST: request.yaml<br>instructions for subsetting]"/]
show_plan[/"--show-plan<br>[--show-plan: flag to output SQL plan]"/]
output_dir[/"subsets/<br>[OUTPUT-DIR: folder]"/]
output[/"subsets/<project-name>/<resource-name>.parquet<br>[Parquet file(s)]"/]
output_dir[/"subset/<br>[OUTPUT-DIR: folder]"/]
output[/"subset/<project-name>/<resource-name>.parquet<br>[Parquet file(s)]"/]

request --> subset
source --> subset
Expand Down