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

322 fix bug subresponder schema #54

Merged
merged 4 commits into from
Aug 9, 2023
Merged

Conversation

okudum
Copy link
Contributor

@okudum okudum commented Aug 7, 2023

Pull Request submission

Notes from Muttesir:

  • A section for the column "instance" added to the subresponder_schema toml file.

  • Checked whether the code runs using "Int64" rather than "int64". Code runs with "Int64"

  • The Dedulced_Data_Type for "questioncode" has been made str, to prevent the column names coming out as floats.

Notes from Anne:

  • on this branch also the date was added as a string to the staged full_responses output. This is to prevent the pipeline failing if someone has the full_responses csv file open.
  • we tried some changes to the .gitignore (with Ilyas) to ensure that the directory logs/run_logs would be created, but as this was not successful Ilyas has created another bugfix ticket for this issue.

Closes or fixes

  • Detail the ticket(s) you are closing with this PR
    Closes # 322

Code

  • Code runs The code runs on my machine and/or CDSW
  • Conflicts resolved There are no conflicts (I have performed a rebase if necessary)
  • Requirements My/our code functions according to the requirements of the ticket
  • Dependencies I have updated the environment yaml so it includes any new libraries I have used
  • Configuration file updated any high level parameters that the user may interact with have been put into the config file (and imported to the script)
  • Clean Code
    • Code is as PEP 8 compliant as I can humanly make it
    • Code passess flake8 linting check
    • Code adheres to DRY
  • Type hints All new functions have type hints

Documentation

Any new code includes all the following forms of documentation:

  • Function Documentation Docstrings within the function(s')/methods have been created
    • Includes Args and returns for all major functions
    • The docstring details data types
  • Updated Documentation: User and/or developer working doc has been updated

Data

  • All data needed to run this script is available in Dev/Test
  • All data is excluded from this pull request
  • Secrets checker pre-commit passes

Testing

  • Unit tests Unit tests have been created and are passing or a new ticket to create tests has been created

Peer Review Section

  • All requirements install from (updated) environment.yaml
  • Documentation has been created and is clear - check the working document
  • Doctrings (Google format) have been created and accurately describe the function's functionality
  • Unit tests pass, or if not present a new ticket to create tests has been created
  • Code runs The code runs on reviewer's machine and/or CDSW

Final approval (post-review)

The author has responded to my review and made changes to my satisfaction.

  • I recommend merging this request.

Review comments

Insert detailed comments here!

These might include, but not exclusively:

  • bugs that need fixing (does it work as expected? and does it work with other code
    that it is likely to interact with?)
  • alternative methods (could it be written more efficiently or with more clarity?)
  • documentation improvements (does the documentation reflect how the code actually works?)
  • additional tests that should be implemented (do the tests effectively assure that it
    works correctly?)
  • code style improvements (could the code be written more clearly?)
  • Do the changes represent a change in functionality so the version number should increase? Start a discussion if so.
  • As a review you can generates the same outputs from running the code

Your suggestions should be tailored to the code that you are reviewing.
Be critical and clear, but not mean. Ask questions and set actions.

@github-actions
Copy link

github-actions bot commented Aug 7, 2023

Percentage Coverage for this PR

Detailed Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
src/aggregation
   __init__.py00100% 
src/estimation
   __init__.py00100% 
src/imputation
   __init__.py00100% 
   imputation.py950100% 
src/outlier_detection
   __init__.py00100% 
src/outputs
   __init__.py00100% 
src/staging
   __init__.py00100% 
   history_loader.py32293%42, 54
   spp_parser.py140100% 
   spp_snapshot_processing.py330100% 
   validation.py801285%45–46, 69, 103, 106, 138, 174, 181, 212–213, 219–220
src/utils
   __init__.py00100% 
   helpers.py25580%14–15, 19–20, 22
   local_file_mods.py46393%116–118
TOTAL3252293% 

Summary of tests

Tests Skipped Failures Errors Time
39 0 💤 0 ❌ 0 🔥 1.743s ⏱️

@okudum okudum changed the title Updated subresponder schema 322 fix bug subresponder schema Aug 7, 2023
Copy link
Collaborator

@jwestw jwestw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This runs but we still need a bug ticket to maintain folder structure in logs/run_logs

@jwestw jwestw merged commit 26cb780 into develop Aug 9, 2023
1 check passed
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.

3 participants