Skip to content

Commit ce395cf

Browse files
committed
📝 update documentation
1 parent 4591a20 commit ce395cf

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

DESCRIPTION

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Package: movedesign
2-
Title: Study design tool for movement ecology studies
2+
Title: Study Design Toolbox for Movement Ecology Studies
33
Version: 0.3.0
44
Authors@R:
55
person("Inês", "Silva", , "i.simoes-silva@hzdr.de", role = c("cre", "aut"),
66
comment = c(ORCID = "0000-0003-4850-6193"))
7-
Description: A Shiny application that helps researchers design movement
8-
ecology studies. The tool focuses on two key objectives: (1)
7+
Description: An R package and Shiny application that helps researchers design
8+
movement ecology studies. The tool focuses on two key objectives: (1)
99
estimating home range areas and (2) estimating fine-scale movement
10-
behavior, specifically speed and distance traveled. It provides
10+
behavior, specifically speed and distance traveled. It provides
1111
interactive simulations and methodological guidance to support study
1212
planning and decision-making. See
1313
<https://ecoisilva.github.io/movedesign/> for more details.

README.Rmd

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,12 @@ knitr::opts_chunk$set(
1717

1818
<!-- badges: start -->
1919

20-
![Static Badge](https://img.shields.io/badge/version-0.3.0-blue) [![DOI](https://zenodo.org/badge/474098792.svg)](https://zenodo.org/badge/latestdoi/474098792)<br> [![R-CMD-check](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml)<br> [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
20+
![Static Badge](https://img.shields.io/badge/version-0.3.0-blue) [![DOI](https://zenodo.org/badge/474098792.svg)](https://zenodo.org/badge/latestdoi/474098792)<br> [![R-CMD-check](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml)
21+
[![R build status](https://github.com/ecoisilva/movedesign/workflows/R-hub/badge.svg)](https://github.com/ecoisilva/movedesign/actions)<br>
22+
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2123
[![Hits](https://hits.sh/github.com/ecoisilva/hits.svg)](https://hits.sh/github.com/ecoisilva/movedesign/) <br>
22-
<!-- ![HitCount](https://img.shields.io/endpoint?color=%234bc61e&url=https%3A%2F%2Fhits.dwyl.com%2Fecoisilva%2Fmovedesign.json)<br> -->
24+
<!-- [![Github last commit date](https://img.shields.io/github/last-commit/ecoisilva/movedesign.svg?label=Updated&logo=github&cacheSeconds=600)](https://github.com/ecoisilva/movedesign/commits) -->
25+
<!-- [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/movedesign)](https://cran.r-project.org/package=movedesign) -->
2326
<!-- badges: end -->
2427

2528
<br>
@@ -57,7 +60,7 @@ movedesign::run_app()
5760

5861
## Using the `movedesign` application:
5962

60-
Start with the guided tutorial in the `'Home'` tab. For a more detailed introduction, refer to the [vignettes](https://ecoisilva.github.io/movedesign/articles/movedesign.html) or the [manuscript](https://doi.org/10.1111/2041-210X.14153).
63+
Start with the guided tutorial in the `'Home'` tab. For a more detailed introduction, refer to the [vignettes](https://ecoisilva.github.io/movedesign/articles/movedesign.html) or the manuscripts (references below).
6164

6265
<img src="https://raw.githubusercontent.com/ecoisilva/movedesign/main/inst/app/www/app_overview.png"
6366
alt="This figure presents a conceptual workflow of the key elements of the ‘movedesign’ application, which provides an R Shiny-powered user interface to test different sampling designs for specified tracking projects."
@@ -76,5 +79,6 @@ To cite `movedesign`, use the following:
7679
citation("movedesign")
7780
```
7881

79-
> Silva, I., Fleming, C. H., Noonan, M. J., Fagan, W. F., & Calabrese, J. M. (2023). movedesign: Shiny R app to evaluate sampling design for animal movement studies. Methods in Ecology and Evolution, 14(9), 2216–2225. https://doi.org/10.1111/2041-210X.14153
82+
> Silva, I., Fleming, C. H., Noonan, M. J., Fagan, W. F., & Calabrese, J. M. (2023). movedesign: Shiny R app to evaluate sampling design for animal movement studies. Methods in Ecology and Evolution, 14(9), 2216–2225. DOI: 10.1111/2041-210X.14153
83+
8084
:::

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,16 @@
77

88
![Static Badge](https://img.shields.io/badge/version-0.3.0-blue)
99
[![DOI](https://zenodo.org/badge/474098792.svg)](https://zenodo.org/badge/latestdoi/474098792)<br>
10-
[![R-CMD-check](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml)<br>
10+
[![R-CMD-check](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ecoisilva/movedesign/actions/workflows/R-CMD-check.yaml)
11+
[![R build
12+
status](https://github.com/ecoisilva/movedesign/workflows/R-hub/badge.svg)](https://github.com/ecoisilva/movedesign/actions)<br>
1113
[![Project Status: Active – The project has reached a stable, usable
1214
state and is being actively
1315
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
1416
[![Hits](https://hits.sh/github.com/ecoisilva/hits.svg)](https://hits.sh/github.com/ecoisilva/movedesign/)
1517
<br>
16-
<!-- ![HitCount](https://img.shields.io/endpoint?color=%234bc61e&url=https%3A%2F%2Fhits.dwyl.com%2Fecoisilva%2Fmovedesign.json)<br> -->
18+
<!-- [![Github last commit date](https://img.shields.io/github/last-commit/ecoisilva/movedesign.svg?label=Updated&logo=github&cacheSeconds=600)](https://github.com/ecoisilva/movedesign/commits) -->
19+
<!-- [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/movedesign)](https://cran.r-project.org/package=movedesign) -->
1720
<!-- badges: end -->
1821

1922
<br>
@@ -73,7 +76,7 @@ movedesign::run_app()
7376
Start with the guided tutorial in the `'Home'` tab. For a more detailed
7477
introduction, refer to the
7578
[vignettes](https://ecoisilva.github.io/movedesign/articles/movedesign.html)
76-
or the [manuscript](https://doi.org/10.1111/2041-210X.14153).
79+
or the manuscripts (references below).
7780

7881
<img src="https://raw.githubusercontent.com/ecoisilva/movedesign/main/inst/app/www/app_overview.png"
7982
alt="This figure presents a conceptual workflow of the key elements of the ‘movedesign’ application, which provides an R Shiny-powered user interface to test different sampling designs for specified tracking projects."
@@ -97,6 +100,6 @@ citation("movedesign")
97100
> Silva, I., Fleming, C. H., Noonan, M. J., Fagan, W. F., & Calabrese,
98101
> J. M. (2023). movedesign: Shiny R app to evaluate sampling design for
99102
> animal movement studies. Methods in Ecology and Evolution, 14(9),
100-
> 2216–2225. <https://doi.org/10.1111/2041-210X.14153>
103+
> 2216–2225. DOI: 10.1111/2041-210X.14153
101104
102105
</div>

0 commit comments

Comments
 (0)