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

Pipelines Cleanup #253

Closed
8 tasks
damonbayer opened this issue Dec 17, 2024 · 1 comment · Fixed by #254
Closed
8 tasks

Pipelines Cleanup #253

damonbayer opened this issue Dec 17, 2024 · 1 comment · Fixed by #254
Assignees

Comments

@damonbayer
Copy link
Collaborator

Given the lack of progress on #48, I think we are overdue for a cleanup of the pipelines directory.

We should

  • Put scripts into folders
    • Pre-processing
    • Model fitting
    • Post-Processing
    • Collation
  • Rename files that are specific to certain models to communicate that in the file name
  • Add some sort of header comment in each file that briefly describes what each file does

This should be done in concert with #235

  • add a readme
@damonbayer damonbayer self-assigned this Dec 17, 2024
@dylanhmorris
Copy link
Contributor

dylanhmorris commented Dec 18, 2024

Add some sort of header comment in each file that briefly describes what each file does
For Python this can and should be the script docstring (before imports, after shebang if any):

#!/usr/bin/env python3 
"""
What this script does
"""

import mylibrary as ml

For R, roxygen-style comment at the top?

#!/usr/bin/env Rscript
#' This script does things

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 a pull request may close this issue.

2 participants