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

refactor summary statistics from struct to function #170

Open
musoke opened this issue Jan 12, 2024 · 1 comment
Open

refactor summary statistics from struct to function #170

musoke opened this issue Jan 12, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@musoke
Copy link
Owner

musoke commented Jan 12, 2024

Currently, summary statistics are extracted by passing a list of structs that have constructors with the appropriate signature. Headers for the resulting CSV are constructed separately and archanely.
Attempting to describe this succinctly in the docs has made it clear that it is not great.

Simplify this by accepting a list of functions instead, each of which returns both data and a header.
The return type could be

  • a tuple (::Vector{String}, ::Vector{Float64}).
    This would be simple, but possibly too ad hoc.

  • a Dataframe.
    This would be a new, possibly undesirable dependency.

@musoke musoke added the enhancement New feature or request label Jan 12, 2024
@musoke musoke added this to the JOSS submission milestone Jan 12, 2024
@musoke musoke removed this from the JOSS review milestone Jan 26, 2024
@musoke
Copy link
Owner Author

musoke commented Jan 26, 2024

Depends on #107

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant