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

Clean up and document analyses/ section #265

Open
dfsnow opened this issue Dec 6, 2024 · 0 comments · May be fixed by #313
Open

Clean up and document analyses/ section #265

dfsnow opened this issue Dec 6, 2024 · 0 comments · May be fixed by #313
Assignees
Labels
pipeline Code that glues all the model bits together reporting Diagnostics via Quarto or related outputs

Comments

@dfsnow
Copy link
Member

dfsnow commented Dec 6, 2024

The analyses/ section is currently a bit of a mess. To clean it up we should:

  • Update the README to explain its purpose (similar to the one under reports/
  • Cleanup the existing workflow documentation
  • Move the .qmd subsections to a dedicated directory
  • Deduplicate the code in helpers.R, since a lot of it overlaps with R/helpers.R
  • Move the "new feature" analysis doc to its own subdirectory, in case we add other types

In general, we want this subdirectory to contain the templates necessary to create one-off analyses (such as evaluating a new feature). The code (a .qmd file) and output (a .html file) should be saved in a subdirectory relative to the template. Something like:

.
└── analyses/
    ├── README.md
    └── new-feature/
        ├── template.qmd
        ├── modules/
        │   ├── aggregated_maps_categorical.qmd
        │   └── other_modules.qmd
        └── 0000-feature-name/
            ├── 0000-feature-name.qmd
            └── 0000-feature-name.html
@dfsnow dfsnow added pipeline Code that glues all the model bits together reporting Diagnostics via Quarto or related outputs labels Dec 6, 2024
@Damonamajor Damonamajor linked a pull request Jan 7, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pipeline Code that glues all the model bits together reporting Diagnostics via Quarto or related outputs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants