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

r4ds-style refactor #69

Merged
merged 16 commits into from
Feb 16, 2021
Merged

r4ds-style refactor #69

merged 16 commits into from
Feb 16, 2021

Conversation

maxheld83
Copy link
Contributor

@maxheld83 maxheld83 commented Dec 17, 2020

Before we continue with actual features, we need a bit of refactoring.
This refactoring has a couple of goals; they are so tightly connected that they have to be one, somewhat monolithic refactor unfortunately:

  1. decoupling (this used to be refactor ELT + analysis codebase #52)
    • the ELT + analysis codebase should be organised in terms of the r4ds book
    • presentation should be separated entirely from analysis.
      The rmarkdown template (for the mail) strictly should not do any work, but should merely define the presentation of results (i.e. the order of tables and perhaps some commentary).
      Among other things, the rmarkdown template currently creates the excel output, which makes this quite brittle (and required the hack-fix for send attachment #44.
      No dependencies in rmarkdown templates, in particular, or at least not without programmatically rendereing the template as part of the check.
  2. documentation in the code
  3. reduce dependencies
  4. tests
  5. assertions (on inputs)

This thould address, among others:

@maxheld83 maxheld83 added this to the Open APC Group (Alpha) milestone Dec 17, 2020
@maxheld83 maxheld83 self-assigned this Dec 17, 2020
@maxheld83 maxheld83 mentioned this pull request Dec 17, 2020
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant