Skip to content

Commit

Permalink
adding doc string info
Browse files Browse the repository at this point in the history
  • Loading branch information
alexpiet committed Sep 6, 2024
1 parent 64036b8 commit d1fc8fb
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/aind_dynamic_foraging_data_utils/alignment.py
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,9 @@ def event_triggered_response( # noqa C901
censor: Boolean
if True (default), censor observations that take place after the next event time
if False, do not censor
censor_times: list or array or None
if None, and censor is True, then use event_times as the censor times
if times are provided, then these are the times at which ETR is censored
Returns:
--------
Expand Down Expand Up @@ -476,6 +479,17 @@ def censor_event_triggered_response(etr, y, t_start, t_end, event_times, censor_
time window
censored timepoints are replaced with NaN, so all data points are still present
etr: dataframe, event triggered response
y: column of the response variable to censor
t_start: start of event triggered response window
t_end: end of event triggered response window
censor: Boolean
if True, censor observations that take place after the next event time
if False, do not censor
censor_times: list or array or None
if None, and censor is True, then use event_times as the censor times
if times are provided, then these are the times at which ETR is censored
"""

if censor_times is None:
Expand Down

0 comments on commit d1fc8fb

Please sign in to comment.