dfe-analytical-services / dfe-analytical-services/dfeR

Create FOI project option in `create_project()`

Open
#80 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
R
Stars
14
Forks
4
Avg merge
4d 5h
Merged PRs (30d)
3

Description

## Is your feature request related to a problem? Please describe.

We're encouraging analysts to use R + Git repos for their FOI work and it would be useful to have a standardised way for them to set this up.

## Describe the solution you'd like

If someone adds a flag - e.g. `project_type="foi"` - when calling the `create_project()`, maybe it could add in some extra standard elements we'd like to see in team FOI repos. For example:

- Standard guidelines added to the readme
- template csv log for FOIs including FOI ID, date received, completion date, response type, exemption used
- template reporting document in quarto / markdown form, which generates metrics on FoI response rates, time to completion, percentage refused under different exemptions etc

## Describe alternatives you've considered

Currently we're expecting analysts to put this together themselves, which will duplicate efforts in creating the report code especially.

## Additional context

This is linked to HoP office's guidance on handling FOIs.

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing create_project() entry point and determine how project options are currently handled. Define the FOI project’s README guidance, CSV log fields, and Quarto or Markdown reporting template, then verify that selecting project_type="foi" creates the agreed standard elements.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.