The-Strategy-Unit / The-Strategy-Unit/nhp_reskit

Add a function that reads a sites selection from the model runs table?

Open
#207 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

could enhancement question
Dominant language
R
Stars
0
Forks
1
Avg merge
2d 23h
Merged PRs (30d)
11

Description

This might be a useful helper if your scenario or scheme has a default list of sites that are included.

The function would return a character vector of site codes, that you could store as a local variable, and then pass to the sites argument of the various reskit compile functions.
If no sites are specified in the table (or ALL) then this function would return NULL, which is then treated by reskit as "no filter".

It would potentially base its lookup on a selection of variables to filter the model runs table on, or it could just require a single argument, the specific row ID (there's already a helper function in azkit that should retrieve a single row from the table, though this might need some adaptation to ensure it is user-friendly enough).

Just an idea for now - would this be useful?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing azkit helper for retrieving a single model-runs row and the reskit compile functions that accept a sites argument. Clarify whether selection uses a row ID or multiple filter variables, then define the behavior for missing sites and ALL. Done means the helper returns site codes or NULL and its interface is settled for use with the compile functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.