Skip to content

Commit 568d7bf

Browse files
committed
Deploying to gh-pages from @ db4a825 🚀
1 parent 2519018 commit 568d7bf

102 files changed

Lines changed: 4741 additions & 197 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

404.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

404.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Content not found. Please use links in the navbar.
2+
3+
# Page not found (404)

LICENSE.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE.md

Lines changed: 669 additions & 0 deletions
Large diffs are not rendered by default.

articles/index.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Articles
2+
3+
### Study design
4+
5+
- [movedesign](https://ecoisilva.github.io/movedesign/articles/movedesign.md):
6+
7+
- [Walkthrough (single
8+
estimate)](https://ecoisilva.github.io/movedesign/articles/tutorial_ind.md):
9+
10+
How to design an animal tracking project with ‘movedesign’
11+
12+
- [Walkthrough
13+
(population-level)](https://ecoisilva.github.io/movedesign/articles/tutorial_pop.md):
14+
15+
How to design an animal tracking project with ‘movedesign’ (for
16+
population-level inferences)
17+
18+
### Installation issues
19+
20+
- [Issues](https://ecoisilva.github.io/movedesign/articles/issues.md):
21+
22+
Common installation issues

articles/issues.html

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/issues.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Issues
2+
3+
## Resolving installation issues
4+
5+
### Check package dependencies:
6+
7+
The `movedesign` package requires many non-default `R` packages. If you
8+
are met with errors during installation/updates, try restarting your `R`
9+
session (in the `RStudio` menu bar, this is `Session` \> `Restart R`; or
10+
close and re-open `R`). Then, reinstall the package using:
11+
12+
``` r
13+
remotes::install_github("ecoisilva/movedesign", dependencies = TRUE)
14+
```
15+
16+
You may also need to explicitly install the `fontawesome` package:
17+
18+
``` r
19+
install.packages("fontawesome")
20+
```
21+
22+
### Resolving “failed to install ‘unknown package’ from GitHub”:
23+
24+
If you see this error when installing from GitHub, follow these steps:
25+
26+
**Step 1:** Generate a GitHub personal access token with the following
27+
command in the RStudio or `R` console:
28+
29+
``` r
30+
usethis::create_github_token()
31+
```
32+
33+
This will take you to GitHub to generate a token. Configure the token
34+
(or just scroll down and generate it using the default settings) and
35+
copy it to your clipboard (it is a string of letters and numbers).
36+
37+
**Step 2:** Save the personal access token in your R environment. Back
38+
in `R`, enter:
39+
40+
``` r
41+
usethis::edit_r_environ()
42+
```
43+
44+
This will open the `.Renviron` file in a new RStudio window. Add the
45+
following line to the file:
46+
47+
GITHUB_PAT="GITHUB_PERSONAL_ACCESS_TOKEN"
48+
49+
Replace `GITHUB_PERSONAL_ACCESS_TOKEN` with the token you just copied
50+
from GitHub.
51+
52+
**Step 3:** Save this file, close it, and restart `R`. After that, you
53+
should be able to install `movedesign` through the usual command:
54+
55+
``` r
56+
remotes::install_github("ecoisilva/movedesign", dependencies = TRUE)
57+
```
58+
59+
------------------------------------------------------------------------
60+
61+
If you encounter any other issues, please contact [Inês
62+
Silva](mailto:i.simoes-silva@hzdr.de?subject=%5Bmovedesign%5D) for
63+
assistance.

articles/movedesign.html

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/movedesign.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# movedesign
2+
3+
## Why `movedesign`?
4+
5+
`movedesign` is built using R language with Shiny for an easy-to-use
6+
user interface (GUI). This application will allow you to test different
7+
tracking schedules while considering an initially set research question
8+
(currently *home range* and *speed/distance* estimation).
9+
10+
- Doesn’t require R coding experience.
11+
- Leverages the `ctmm` R package for statistically unbiased methods.
12+
13+
## How to start:
14+
15+
The application includes a built-in guided tutorial to help you navigate
16+
its features. When you open the `'Home'` tab, you’ll find the following:
17+
18+
![](images/tutorial1_img1.png)
19+
20+
This step-by-step guide will walk you through the app, ensuring you
21+
understand its features and functionality. When an action is required,
22+
it will be clearly highlighted. Please follow these instructions
23+
carefully, as each step builds on the previous one. If no action is
24+
needed, simply continue to the next step by clicking `'Next'` or
25+
pressing the right arrow key on your keyboard. The information from the
26+
guided tour is also partially available below.
27+
28+
![](data:image/svg+xml;base64,PHN2ZyBhcmlhLWhpZGRlbj0idHJ1ZSIgcm9sZT0iaW1nIiB2aWV3Ym94PSIwIDAgNTEyIDUxMiIgc3R5bGU9ImhlaWdodDoxZW07d2lkdGg6MWVtO3ZlcnRpY2FsLWFsaWduOi0wLjEyNWVtO21hcmdpbi1sZWZ0OmF1dG87bWFyZ2luLXJpZ2h0OmF1dG87Zm9udC1zaXplOmluaGVyaXQ7ZmlsbDojREI0NTQ1O292ZXJmbG93OnZpc2libGU7cG9zaXRpb246cmVsYXRpdmU7Ij48cGF0aCBkPSJNMjU2IDUxMkEyNTYgMjU2IDAgMSAwIDI1NiAwYTI1NiAyNTYgMCAxIDAgMCA1MTJ6bTAtMzg0YzEzLjMgMCAyNCAxMC43IDI0IDI0VjI2NGMwIDEzLjMtMTAuNyAyNC0yNCAyNHMtMjQtMTAuNy0yNC0yNFYxNTJjMC0xMy4zIDEwLjctMjQgMjQtMjR6TTIyNCAzNTJhMzIgMzIgMCAxIDEgNjQgMCAzMiAzMiAwIDEgMSAtNjQgMHoiIC8+PC9zdmc+)Warning:
29+
During the guided tutorial, refrain from interacting with anything
30+
outside the highlighted zones to avoid interruptions.
31+
32+
This tutorial provides an overview of key features but does not cover
33+
detailed definitions. For more in-depth explanations, you can access
34+
comprehensive
35+
![](data:image/svg+xml;base64,PHN2ZyBhcmlhLWhpZGRlbj0idHJ1ZSIgcm9sZT0iaW1nIiB2aWV3Ym94PSIwIDAgNTEyIDUxMiIgc3R5bGU9ImhlaWdodDoxZW07d2lkdGg6MWVtO3ZlcnRpY2FsLWFsaWduOi0wLjEyNWVtO21hcmdpbi1sZWZ0OmF1dG87bWFyZ2luLXJpZ2h0OmF1dG87Zm9udC1zaXplOmluaGVyaXQ7ZmlsbDpjdXJyZW50Q29sb3I7b3ZlcmZsb3c6dmlzaWJsZTtwb3NpdGlvbjpyZWxhdGl2ZTsiPjxwYXRoIGQ9Ik00NjQgMjU2QTIwOCAyMDggMCAxIDAgNDggMjU2YTIwOCAyMDggMCAxIDAgNDE2IDB6TTAgMjU2YTI1NiAyNTYgMCAxIDEgNTEyIDBBMjU2IDI1NiAwIDEgMSAwIDI1NnptMTY5LjgtOTAuN2M3LjktMjIuMyAyOS4xLTM3LjMgNTIuOC0zNy4zaDU4LjNjMzQuOSAwIDYzLjEgMjguMyA2My4xIDYzLjFjMCAyMi42LTEyLjEgNDMuNS0zMS43IDU0LjhMMjgwIDI2NC40Yy0uMiAxMy0xMC45IDIzLjYtMjQgMjMuNmMtMTMuMyAwLTI0LTEwLjctMjQtMjRWMjUwLjVjMC04LjYgNC42LTE2LjUgMTIuMS0yMC44bDQ0LjMtMjUuNGM0LjctMi43IDcuNi03LjcgNy42LTEzLjFjMC04LjQtNi44LTE1LjEtMTUuMS0xNS4xSDIyMi42Yy0zLjQgMC02LjQgMi4xLTcuNSA1LjNsLS40IDEuMmMtNC40IDEyLjUtMTguMiAxOS0zMC42IDE0LjZzLTE5LTE4LjItMTQuNi0zMC42bC40LTEuMnpNMjI0IDM1MmEzMiAzMiAwIDEgMSA2NCAwIDMyIDMyIDAgMSAxIC02NCAweiIgLz48L3N2Zz4=)**help
36+
tips** at any time. Documentation is also available on Silva *et al.*
37+
([2023](#ref-silva2023movedesign)).
38+
39+
### Workflows
40+
41+
These are the current options for `movedesign` workflows. Users may
42+
configure their study design by selecting different options for data
43+
source, research target, and analytical target. All workflows follow a
44+
stepwise approach, with tabs displayed sequentially on the right
45+
sidebar. Irrelevant tabs for the current workflow will be automatically
46+
hidden.
47+
48+
**Step 1.** *Data source:*
49+
50+
Users can specify what is their data source:
51+
52+
`Upload`: Import a dataset from a local file.
53+
54+
`Select`: Choose from pre-existing datasets available in the
55+
application.
56+
57+
`Simulate`: Generate synthetic data for testing or modeling purposes.
58+
59+
**Step 2.** *Research target:*
60+
61+
Users can define their research targets:
62+
63+
`Home range`: Estimate long-term space-use requirements.
64+
65+
`Speed & distance`: Estimate fine-scale movement metrics, such as speed
66+
and distance traveled.
67+
68+
**Step 3.** *Analytical target:*
69+
70+
Users can decide on their analytical target for the estimates:
71+
72+
`Individual estimate`: Obtain metrics for a single individual.
73+
74+
`Mean estimate of sampled population`: Obtain a mean estimate across a
75+
sampled group.
76+
77+
`Compare estimates of two sampled groups`: Perform a comparative
78+
analysis between two groups within a tracked population (for the
79+
detection of sub-groups).
80+
81+
Additionally, users have the option to:
82+
83+
`Add individual variation`: Include variation among individuals during
84+
simulations (only available for mean and estimate comparisons).
85+
86+
Go
87+
[here](https://ecoisilva.github.io/movedesign/articles/tutorial_ind.html)
88+
for more detailed information regarding the `Individual estimate`
89+
workflow.
90+
91+
### Related work
92+
93+
- The [ctmm](https://github.com/ctmm-initiative/ctmm) R package and
94+
[ctmmweb](https://github.com/ctmm-initiative/ctmmweb) Shiny
95+
application.
96+
97+
### References
98+
99+
Silva, I., Fleming, C. H., Noonan, M. J., Fagan, W. F., & Calabrese, J.
100+
M. (2023). Movedesign: Shiny r app to evaluate sampling design for
101+
animal movement studies. *Methods in Ecology and Evolution*, *14*(9),
102+
2216–2225. <https://doi.org/10.1111/2041-210X.14153>

0 commit comments

Comments
 (0)