Skip to content
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.

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

Automate setup of auto-reject project #5

Open
2 tasks
arthur-shaw opened this issue Feb 4, 2023 · 0 comments
Open
2 tasks

Automate setup of auto-reject project #5

arthur-shaw opened this issue Feb 4, 2023 · 0 comments
Labels
epic 🗻 Epic containing several related issues

Comments

@arthur-shaw
Copy link
Owner

Objective 🎯

Make initial setup of an auto-reject project as easy as running a single function.

In longer form:

To create a data processing framework, one needs several complex inputs: how to connect to the Survey Solutions server, which questionnaires to handle, which Survey Solutions statuses to handle, how to describe a completed interview, and which issues warrant review and rejection. Additionally, one needs a set of scripts that execute a complex sequence of actions: acquire the data, combine the data, identify issues, look for explanatory comments, decide how to handle each interview, and reject interviews that warrant rejection. At present, each data processing framework is, by and large, hand-crafted. Under this proposal work will be done to improve the situation in two complementary ways. To set up a new system, one will be able to create the scaffolding for a new project with a single command, much like usethis does for projects and packages. To customize the framework, adapation should be done, to the extent possible, through other means–for example, through an Excel file, Shiny app, or other low-code interface that captures how to connect with the Survey Solutions server, how issues identify issues, and what to do with each issue.

User stories 📇

  • Set up scaffolding for auto-reject like usethis does for projects and packages
  • Capture necessary user parameters
  • Message in console about user's next actions
  • Offer common optional modules (e.g., construct single consumption roster)
  • Provide a wizard for common needs (e.g., only 1 head)

Tasks ⚙️

Scoping 🔭

  • Research how usethis does this
  • Research derivative projects (e.g., Jon's andthis, starter, etc.)
  • Identify necessary user parameters
  • Identify common variations

Development 👨‍💻

Documentation ✍️

  • Create section in reference index page
  • Write vignette on working with calendar events
@arthur-shaw arthur-shaw added the epic 🗻 Epic containing several related issues label Feb 4, 2023
@arthur-shaw arthur-shaw moved this to Backlog 📇 in susoapi Feb 4, 2023
@arthur-shaw arthur-shaw removed this from susoapi Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic 🗻 Epic containing several related issues
Projects
None yet
Development

No branches or pull requests

1 participant