Skip to content

Commit

Permalink
Update condense.jl
Browse files Browse the repository at this point in the history
It took me way too long to figure out how the function works: I hope this helps
  • Loading branch information
ReneSkukies authored Jan 22, 2025
1 parent 7541c2b commit 48105d4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/condense.jl
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,9 @@ Converts an array-result (prediction or coefficient) together with the events, t
To support multi-event models, we expect everything to be put into `Vectors` - this should be refactored at some point to be compatible with broadcasting, but it is not right now.
## args
`eff`: Contains the array(s) to be converted to a tidy dataframe. Should be 3D, with channel x time x predictor
`events`: A vector of event-dataframes, each need to match `size(eff,3)`
`times`: A vector of time-vectors, each need to match `size(eff,2)`
`eff`: A vector that contains the array(s) to be converted to a tidy dataframe. Each event in your events dataframe your have it's own array (i.e. the array should have `length(eff) == length(unique(events.event))`). Each array should be 3D, with channel x time x predictor
`events`: A vector of event-dataframes, each need to match `size(eff,3)`. Each individual event (`unique(events.event)`) should have it's own dataframe. E.g. `[[df_event1::DataFrame], [df_event1::DataFrame]]
`times`: A vector of time-vectors with `length(eff)`, each time-vector needs to match `size.(eff,2)`
`eventnames`: A vector of eventnames, either symbols or strings, should be a single entry per event
"""
result_to_table(model, eff, events::Vector{<:DataFrame}) =
Expand Down

0 comments on commit 48105d4

Please sign in to comment.