diff --git a/README.md b/README.md index ad17d6a..862168e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ pip install -U ndx-binned-spikes ## Usage -The `BinnedAlignedSpikes` object is designed to store counts of spikes around a set of events (e.g. stimuli or behavioral events such as licks). The events are characterized by their timestamps and a bin data structure is used to store the spike events around each of the event timestamps. The `BinnedAlignedSpikes` keeps a separate count for each of the units (e.g. neurons). +The `BinnedAlignedSpikes` object is designed to store counts of spikes around a set of events (e.g. stimuli or behavioral events such as licks). The events are characterized by their timestamps and a bin data structure is used to store the spike events around each of the event timestamps. The `BinnedAlignedSpikes` keeps a separate count for each of the units (e.g., neurons). ### Simple example The following code illustrates the use of this extension: @@ -66,7 +66,7 @@ ecephys_processinng_module.add(binned_aligned_spikes) ### Parameters and data structure The structure of the bins are characterized with the following parameters: -* `milliseconds_from_event_to_first_bin`: The time in milliseconds from the event to the first bin. A negative values indicates that the first bin is before the event whereas a positive value indicates that the first bin is after the event. +* `milliseconds_from_event_to_first_bin`: The time in milliseconds from the event to the first bin. A negative value indicates that the first bin is before the event whereas a positive value indicates that the first bin is after the event. * `bin_width_in_milliseconds`: The width of each bin in milliseconds.