Reimplement recipe subcommand #72

sgreenbury · 2024-07-26T10:52:49Z

Closes #67.

Reimplementation of recipe subcommand with the following approach:

Reintroduce and revise DataRequestSpec to enable use of previous recipes.
Revise types in metric specification to be either MetricId or MetricText combinable in search with logical OR.
Implement TryFrom<DataRequestSpec> for SearchParams to enable search/download with same API
Add fn write_output to reduce repetition
Add BBox to search params (also towards Additional search functionality #66)
~~Enable recipe command to use the either DataRequestSpec or SearchParams~~ (this is an enhancement, so will open in a new issue)

src/cli.rs

src/lib.rs

src/search.rs

test_recipe.json

src/search.rs

Revised `impl From<SearchParams> for Option<Expr>` to combine fields such that IDs are considered distinctly with OR alongside other fields.

src/data_request_spec.rs

sgreenbury · 2024-08-30T15:03:34Z

src/search.rs

+/// Aside from `metric_id`, each of the fields are combined with an AND operation, so searching for
+/// both text and a year range will only return metrics that satisfy both parameters.
 ///
 /// However, if a parameter has multiple values (e.g. multiple text strings), these are combined
 /// with an OR operation. So searching for multiple text strings will return metrics that satisfy
 /// any of the text strings.
-#[derive(Clone, Debug, Deserialize, Serialize)]
+///
+/// `metric_id` is considered distinctly since the list of values uniquely identifies a set of
+/// metrics. This list of metrics is combined with the final combined expression of the other fields
+/// with an OR operation. This enables a search or recipe to contain a combination of specific
+/// `metric_id`s and other fields.


Updated the search to be either metric_id OR (<other fields> combined with AND) to enable recipes to be a combination of metric IDs and other specifications. We should explore during user testing if this is an intuitive and useful modification or not.

Remove obsolete `MetricRequestResult` type and method on `DataRequestSpec` for generating a `MetricRequestResult`

sgreenbury added 10 commits July 17, 2024 07:19

Add data request config

b7c4c93

Add FromStr impl for YearRange

b1eebb9

Add try_from for DataRequestSpec into SearchParams

b3f5475

Add bbox to search params, use FromStr impl

e3b20cc

Reimplement recipe command, make geometry spec optional

f380178

Refactor writing output

cc65265

Include additional error handling for recipes

7a39e7b

Add MetricText for search params from data request spec

f57460f

Update gitignore

dbd1c60

Add get API for popgetter

7d73d94

sgreenbury marked this pull request as ready for review July 30, 2024 16:20

andrewphilipsmith assigned sgreenbury Aug 8, 2024

sgreenbury mentioned this pull request Aug 9, 2024

Reimplemented DataRequestSpec for python bindings #79

Closed