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 metadata to outputs #1594

Merged
merged 23 commits into from
Sep 18, 2024
Merged

Add metadata to outputs #1594

merged 23 commits into from
Sep 18, 2024

Conversation

HaleySchuhl
Copy link
Contributor

@HaleySchuhl HaleySchuhl commented Sep 5, 2024

Describe your changes
Currently, there is very little metadata in the output file (single-value-traits or multi-value-traits).

Provide metadata to get stored alongside any pcv data:

PlantCV version
Date and time in which the workflow was run
Size of the image (in pixels)

Type of update
Is this a:

  • New feature or feature enhancement
  • Work in progress

Associated issues

Additional context
Add any other context about the problem here.

For the reviewer
See this page for instructions on how to review the pull request.

  • Wrap all metadata in list within add_metadata method and test functionality in parallel
  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@HaleySchuhl HaleySchuhl added enhancement Enhancements to existing features update Updates an existing feature/method labels Sep 5, 2024
Copy link

deepsource-io bot commented Sep 5, 2024

Here's the code health analysis summary for commits 0d60cc6..9169662. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage100%100%
Line Coverage100%100%
New Branch Coverage100%100%
New Composite Coverage100%100%
New Line Coverage100%, ✅ Above Threshold100%, ✅ Above Threshold

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@nfahlgren nfahlgren added this to the PlantCV v4.6 milestone Sep 17, 2024
@nfahlgren nfahlgren merged commit 0f0a7f7 into main Sep 18, 2024
5 checks passed
@nfahlgren nfahlgren deleted the add_metadata_to_outputs branch September 18, 2024 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancements to existing features ready to review update Updates an existing feature/method
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add image metadata to output file
2 participants