From 2ef5bb07c7264d8b61f63ac1aa2186b04bf00b0e Mon Sep 17 00:00:00 2001
From: niksirbi <niko.sirbiladze@gmail.com>
Date: Fri, 25 Oct 2024 11:54:32 +0100
Subject: [PATCH] added tip for R users
---
README.md | 7 ++++++-
docs/source/index.md | 3 +++
docs/source/snippets/animovement-tip.md | 7 +++++++
3 files changed, 16 insertions(+), 1 deletion(-)
create mode 100644 docs/source/snippets/animovement-tip.md
diff --git a/README.md b/README.md
index 5b1dec347..da35dd48c 100644
--- a/README.md
+++ b/README.md
@@ -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.
diff --git a/docs/source/index.md b/docs/source/index.md
index 629027b91..1c9d2d0e9 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -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'
diff --git a/docs/source/snippets/animovement-tip.md b/docs/source/snippets/animovement-tip.md
new file mode 100644
index 000000000..ff600847c
--- /dev/null
+++ b/docs/source/snippets/animovement-tip.md
@@ -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.
+:::