Name of App (Give your app a short and informative title. Please adhere to our convention of Title Case without hyphens (e.g. My New App))
MoveApps
Github repository: github.com/yourAccount/Name-of-App (provide the link to the repository where the code of the App can be found)
(Note: all text in italics are instructions for filling out this template. Please replace or delete them before publishing your App.)
(Optional, but very helpful for Users: add here a screenshot or example figure of a typical result of the App, e.g. a plot, a map or a table. Save the image in the repository (e.g. in a folder documentation/) and include it with:
Enter here the short description of the App that might also be used when filling out the description during App submission to MoveApps. This text is directly presented to Users that look through the list of Apps when compiling Workflows.
Enter here a detailed description of your App. What is it intended to be used for. Which steps of analyses are performed and how. Please be explicit about any detail that is important for use and understanding of the App and its outcomes. You might also refer to the sections below.
State here if the App was developed for a specific species, taxon or taxonomic group, or to answer a specific question. How might it influence the scope and utility of the App. This information will help the user to understand why the App might be producing no or odd results.
Examples:
This App was developed for any taxonomic group.
This App was developed using data of birds.
This App was developed using data of red deer.
This App was developed to identify kill sites, but can probably be used to identify any kind of location clusters like nests, dens or drinking holes.
State here the required and/or optimal data properties for this App to perform properly.
Examples:
This App is only applicable to data that reflect range resident behavior.
The data should have a fix rate of at least 1 location per 30 minutes.
The App should work for any kind of (location) data.
Indicate which type of input data the App requires.
Example: move2::move2_loc
Indicate which type of output data the App produces to be passed on to subsequent Apps.
Example: move2::move2_loc
If the App creates artefacts (e.g. csv, pdf, jpeg, shapefiles, etc), please list them here and describe each.
Example: rest_overview.csv: csv-file with Table of all rest site properties
Please list and define all settings/parameters that the App requires to be set by the App user, if necessary including their unit. Please first state the Setting name the user encounters in the Settings menu defined in the appspec.json, and between brackets the argument name used in the code of the R function, to be able to identify it quickly in the code if needed. Please also state the default value, if there is one.
Example: Radius of resting site (radius): Defined radius the animal has to stay in for a given duration of time for it to be considered resting site. Unit: metres. Default: 1000.
Specify here how and if the App modifies the input data. Describe clearly what e.g. each additional column means.
Examples:
The App adds to the input data the columns Max_dist and Avg_dist. They contain the maximum distance to the provided focal location and the average distance to it over all locations.
The App filters the input data as selected by the user.
The output data is the outcome of the model applied to the input data.
The input data remains unchanged.
Please describe here the most common errors of the App: how they occur and the best ways of solving them. You can also indicate for settings, as well as for the input data, which behaviour the App is supposed to show in case of errors or NULL values/input, including possible errors that can happen if settings/parameters are improperly set. Add here also any other important information that you find the User should be aware of.
Examples:
Setting radius: If no radius AND no duration are given, the input data set is returned with a warning. If no radius is given (NULL), but a duration is defined then a default radius of 1000m = 1km is set.
Input data: If the input data contain fewer than 3 locations per track, the App stops with an error message stating which tracks are affected.
Common error: If the App is used on data with a very low fix rate, no resting sites are found and the App returns an empty data set. Adapt the settings radius and duration to the resolution of your data.
Optional, but recommended. Summarize here how the App works "under the hood", so that Users and developers can get a quick idea of the methods, dependencies and assumptions without having to read the code. Keep it short (a few sentences or bullet points) and mention only what is not already obvious from the sections above.
Suggested points to cover:
- The main library/package(s) the core calculation relies on, ideally naming the central function(s) (e.g.
move2,sf,amt,ctmm,lme4). - The method or algorithm applied, and the reference/publication it is based on, if any.
- Assumptions made in the code (e.g. the locations are assumed to be independent).
- The level at which the data are processed (e.g. per track/individual, per track and year, on the whole data set at once).
- Anything relevant for performance (e.g. runtime or memory increases strongly with the number of locations, parallelization).
- Known simplifications or limitations of the implementation.