Enable passing in empirical data to bootstrap

Open
  • Is something wrong?
#100 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
r
Domain
backend

Research direction

The issue describes changing the bootstrap function to accept data instead of selecting hard-coded US or UK data by country, but it names no source files or tests. Start by locating the bootstrap function and its callers, then check the related issues #99 and #97 for context. Done means users can supply the empirical data and the US and UK options pass the corresponding data into the bootstrap.

Written by the indexing model from the issue text.

Description

enhancement

We currently do not allow users to pass in data to be bootstrapped. It could be nice to allow for users to pass in data to the bootstrap (if that data is provided in certain condition). The US and UK options would then select for US or UK data to be passed into the bootstrap function (rather than hard-coded within the bootstrap function.

If this were a user facing package I think this would be worth adding.

So the pattern I'd propose is like:

data <- us_data

bootstrap <- function(data) {
  # do the bootstrap
}

Rather than what we do currently which is like:

bootstrap <- function(country) {
  if(country == "US") {
    data <- us_data
    # do the bootstrap
  }
  # etc. etc.
}

See: #99, #97.

Dominant language
R
Stars
8
Forks
4
Avg merge
3d 18h
Merged PRs (30d)
3

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from petal-code/helios

All issues in petal-code/helios

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.