Skip to content

Commit

Permalink
Use Released Intervals.jl (#9)
Browse files Browse the repository at this point in the history
* Delete manifest files
* Depends on released Intervals.jl
* Fix Julia 1.6 compatibility

Co-authored-by: Phillip Alday <[email protected]>

Co-authored-by: Phillip Alday <[email protected]>
  • Loading branch information
haberdashPI and palday authored Jul 12, 2022
1 parent eb7df5f commit 49f71fa
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 558 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Manifest.toml
307 changes: 0 additions & 307 deletions Manifest.toml

This file was deleted.

2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DataFrameIntervals"
uuid = "33b79e07-adbe-4034-b8be-6bacde625d75"
authors = ["Beacon Biosignals, Inc."]
version = "0.0.2"
version = "0.1.0"

[deps]
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Expand Down
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,14 @@
[![Docs: Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://beacon-biosignals.github.io/DataFrameIntervals.jl/dev)

DataFrameIntervals provides two functions that are handy for computing joins over intervals
of time: `interval_join` and `groupby_interval_join`, and a helper function called `quantile_windows`.
of time: `interval_join` and `groupby_interval_join`, and a helper function called `quantile_windows`. See their doc strings for details.

Rows match in this join if their time spans overlap. The time spans can be represented as

- [`TimeSpan`](https://juliapackages.com/p/timespans) objects
- [`Interval`](https://juliapackages.com/p/intervals) objects.
- `NamedTuples` with a `start` and `stop` field.

Currently this requires an unreleased version of `Intervals.jl` (which should be version 1.8 when released). If you don't use the manifest, make sure to add the following to your project before adding `DataFrameIntervals`.

```
julia> ]add https://github.com/invenia/Intervals.jl#rf/intervalset-type
```


## Example

```julia
Expand Down
Loading

2 comments on commit 49f71fa

@haberdashPI
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@beacon-buddy register

@beacon-buddy
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: beacon-biosignals/BeaconRegistry/625

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 49f71fa457480fc60cf005f753fdcb81bddda56e
git push origin v0.1.0

Please sign in to comment.