Skip to content

Commit

Permalink
added tip for R users
Browse files Browse the repository at this point in the history
  • Loading branch information
niksirbi committed Oct 28, 2024
1 parent 7813e7c commit 58b69e1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,15 @@ We aim to support a range of pose estimation packages, along with 2D or 3D track

Find out more on our [mission and scope](https://movement.neuroinformatics.dev/community/mission-scope.html) statement and our [roadmap](https://movement.neuroinformatics.dev/community/roadmaps.html).

## Status
> [!Warning]
> 🏗️ The package is currently in early development and the interface is subject to change. Feel free to play around and provide feedback.
> [!Tip]
> If you prefer analysing your data in R, we recommend checking out the
> [animovement](https://www.roald-arboel.com/animovement/) toolbox, which is similar in scope.
> We are working together with its developer
> to gradually converge on common data standards and workflows.
## Join the movement

Contributions to movement are absolutely encouraged, whether to fix a bug, develop a new feature, or improve the documentation.
Expand Down
3 changes: 3 additions & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ Find out more on our [mission and scope](target-mission) statement and our [road
```{include} /snippets/status-warning.md
```

```{include} /snippets/animovement-tip.md
```

## Citation
```{include} ../../README.md
:start-after: '## Citation'
Expand Down
7 changes: 7 additions & 0 deletions docs/source/snippets/animovement-tip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:::{admonition} Tip for R users
:class: Tip
If you prefer analysing your data in R, we recommend checking out the
[animovement](https://www.roald-arboel.com/animovement/) toolbox, which is similar in scope.
We are working together with its developer
to gradually converge on common data standards and workflows.
:::

0 comments on commit 58b69e1

Please sign in to comment.