Add a How-to guide for the dataframe API #7727
Conversation
Deployed docs
|
abey79
added
📖 documentation
| # only keep rows where a position is available for the robot | ||
| view = view.filter_is_not_null(rr.dataframe.ComponentColumnSelector("/world/robot", "Position3D")) |
There was a problem hiding this comment.
it would be so nice if this could be written as
# only keep rows where a position is available for the robot
view = view.filter_is_not_null("/world/robot:Position3D")There was a problem hiding this comment.
We have the code for this kind of parsing in crates/store/re_log_types/src/path/parse_path.rs (ComponentPath::from_str)
There was a problem hiding this comment.
When I started looking into this it got hung up on questions like whether
"world/camera/**:[Image,Transform3D,Pinhole]"
is a legal expression.
| "/world/scene": ["Text"], | ||
| }) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I'm following along with a code editor and at this point I'm wondering a lot what I can do with a view to get data. Should probably go here somewhere
| view = view.filter_range_sequence(0, 10) | ||
| ``` | ||
|
|
||
| This API exists for both temporal and sequence timeline, and for various units: |
There was a problem hiding this comment.
all of these should be api links?
There was a problem hiding this comment.
hmm maybe not yet because we haven't document all of them that well yet
What
This PR introduces a How-to guid for the dataframe API which includes:
Needs this to pass CI:
lint.py#7720Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerCHANGELOG.mdand the migration guideTo run all checks from
main, comment on the PR with@rerun-bot full-check.