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

Add support for custom metadata validation & custom BioSample packages #228

Merged
merged 20 commits into from
Dec 18, 2024

Conversation

jessicarowell
Copy link
Collaborator

Description

This PR remedies the existing custom metadata functionality to correctly populate the submission.xml file with BioSample attributes that are added to input metadata Excel file. It performs a minimal validation on them at this time: it replaces the field name with an (optional) alternative ("new_field_name") and fill empty values with user-specified text ("replace_empty_with").

Changes:

  1. Remove two keys from example_custom_metadata.json
  2. Rewrite portion of validate_metadata.py to simplify custom metadata validation
  3. Move submission config file to conf/ folder (and remove department ID and org_ID defaults)
  4. Remove the bin/config_files folder as no longer needed
  5. Add example JSON and Metadata Excel templates for One Health Enterics BioSample package

Checklist

General Checks

  • [] Have you run appropriate tests (unit/integration/end-to-end) to check logic across run environments (Conda/Docker/Singularity on Scicomp/AWS/NF Tower/Local)?

    For each relevant configuration:

    • Can the program run completely through without erroring out?
    • Does it produce the expected outputs, given the inputs provided?
  • [] Have you conducted proper linting procedures?

    • Numpy formatted docstrings for functions
    • Comments explaining lines of code
    • Consistent and intuitive naming conventions for variables, functions, classes, methods, attributes, and scripts
    • Single empty line between class functions, two lines between non-class functions, and two lines between imports and code body
    • Camel case formatting for class names
  • Have you updated existing documentation (README.md, etc.) or created new ones within docs?

CDC Checks

  • Did you check for sensitive data, and remove any?
  • If you added or modified HTML, did you check that it was 508 compliant?

Are additional approvals needed for this change? If so, please mention them below:

Are there potential vulnerabilities or licensing issues with any new dependencies introduced? If so, please mention them below:

@jessicarowell jessicarowell merged commit 1ffdc5f into dev Dec 18, 2024
@jessicarowell
Copy link
Collaborator Author

Emergency merging because people are out for the holidays. I may or may not regret this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment