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

Problem: output formats are difficult for programs to parse and associate with original components and connections #87

Open
michael-okeefe opened this issue Aug 23, 2024 · 0 comments
Labels
enhancement New feature or request low-priority "Nice to have" but not necessary; prioritize lower refactor Refactoring the code to improve clarity/performance.

Comments

@michael-okeefe
Copy link
Member

Problem Description

The two current output formats (out.csv and stats.csv) are nice human-readable formats that can be pulled up into Microsoft Excel or other spreadsheet programs. However, they are difficult to parse and associate back with the original objects from the input TOML file. In particular, for the out.csv file:

  • some metrics are by component
  • some metrics are by connection

Because of the above, it may not be as easy to associate metrics with the input file components -- especially for a computer program.

Areas to Investigate

  • Add a second header row that clearly distinguishes which component or which connection the metric is associated with
  • make labels easier / clearer to parse and more consistent

Additionally, although we would never want to eliminate the CSV format, we may want to also add the ability to write out to a JSON format although that option needs to be further investigated as it may have implications for the event writing code.

@michael-okeefe michael-okeefe added enhancement New feature or request refactor Refactoring the code to improve clarity/performance. labels Aug 23, 2024
@michael-okeefe michael-okeefe added this to the 2024 (Year End) milestone Aug 23, 2024
@michael-okeefe michael-okeefe added the low-priority "Nice to have" but not necessary; prioritize lower label Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request low-priority "Nice to have" but not necessary; prioritize lower refactor Refactoring the code to improve clarity/performance.
Projects
None yet
Development

No branches or pull requests

1 participant