From 2f0bb51eebde37e000fe886d12cd1caab65dc3c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikkel=20Roald-Arb=C3=B8l?= Date: Wed, 11 Sep 2024 11:05:36 +0200 Subject: [PATCH] Change navbar to tutorial --- README.Rmd | 12 ++++++------ README.md | 12 ++++++------ _pkgdown.yml | 12 ++++++++++++ trackballr.Rproj => animovement.Rproj | 0 ...atistics.Rmd => calculate-summary-statistics.Rmd} | 0 5 files changed, 24 insertions(+), 12 deletions(-) rename trackballr.Rproj => animovement.Rproj (100%) rename vignettes/articles/{calculate-movement-statistics.Rmd => calculate-summary-statistics.Rmd} (100%) diff --git a/README.Rmd b/README.Rmd index ac1f2a9..4fc7d7b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -45,14 +45,14 @@ library("animovement") Analysis of animal movement follows a similar workflow irrespective of the type of data (e.g. pose estimation, centroid tracking, trackball, treadmill). See our docs to go through the steps, one-by-one: -- [Introduction to `animovement`](https://www.roald-arboel.com/animovement/articles/Introduction-to-animovement.html) -- [Read trackball data](https://www.roald-arboel.com/animovement/articles/Read-trackball.html) -- [Clean tracks](https://www.roald-arboel.com/animovement/articles/Clean-tracks.html) -- [Compute kinematics](https://www.roald-arboel.com/animovement/articles/Compute-kinematics.html) -- [Compute movement statistics](https://www.roald-arboel.com/animovement/articles/Compute-movement-statistics.html) +- [Introduction to `animovement`](https://www.roald-arboel.com/animovement/articles/animovement.html) +- [Read trackball data](https://www.roald-arboel.com/animovement/articles/read-trackball.html) +- [Clean tracks](https://www.roald-arboel.com/animovement/articles/clean-tracks.html) +- [Compute kinematics](https://www.roald-arboel.com/animovement/articles/calculate-kinematics.html) +- [Compute movement statistics](https://www.roald-arboel.com/animovement/articles/calculate-summary-statistics.html) ## Status -> [!Warning] +> **Warning** > > 🏗️ The package is currently in early development and the interface is subject to change. Feel free to play around and provide feedback. diff --git a/README.md b/README.md index bea1ffd..599fe21 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,19 @@ the type of data (e.g. pose estimation, centroid tracking, trackball, treadmill). See our docs to go through the steps, one-by-one: - [Introduction to - `animovement`](https://www.roald-arboel.com/animovement/articles/Introduction-to-animovement.html) + `animovement`](https://www.roald-arboel.com/animovement/articles/animovement.html) - [Read trackball - data](https://www.roald-arboel.com/animovement/articles/Read-trackball.html) + data](https://www.roald-arboel.com/animovement/articles/read-trackball.html) - [Clean - tracks](https://www.roald-arboel.com/animovement/articles/Clean-tracks.html) + tracks](https://www.roald-arboel.com/animovement/articles/clean-tracks.html) - [Compute - kinematics](https://www.roald-arboel.com/animovement/articles/Compute-kinematics.html) + kinematics](https://www.roald-arboel.com/animovement/articles/calculate-kinematics.html) - [Compute movement - statistics](https://www.roald-arboel.com/animovement/articles/Compute-movement-statistics.html) + statistics](https://www.roald-arboel.com/animovement/articles/calculate-summary-statistics.html) ## Status -> \[!Warning\] +> **Warning** > > 🏗️ The package is currently in early development and the interface is > subject to change. Feel free to play around and provide feedback. diff --git a/_pkgdown.yml b/_pkgdown.yml index 4dcd229..c7400d4 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -45,6 +45,18 @@ reference: - calculate_statistics navbar: + components: + articles: + text: Tutorial + menu: + - text: Read trackball data + href: articles/read-trackball.html + - text: Clean tracks + href: articles/clean-tracks.html + - text: Calculate kinematics + href: articles/calculate-kinematics.html + - text: Calculate summary statistics + href: articles/calculate-summary-statistics.html structure: left: [intro, articles, reference, news] right: [search, github, lightswitch] diff --git a/trackballr.Rproj b/animovement.Rproj similarity index 100% rename from trackballr.Rproj rename to animovement.Rproj diff --git a/vignettes/articles/calculate-movement-statistics.Rmd b/vignettes/articles/calculate-summary-statistics.Rmd similarity index 100% rename from vignettes/articles/calculate-movement-statistics.Rmd rename to vignettes/articles/calculate-summary-statistics.Rmd