-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
119 lines (77 loc) · 6.09 KB
/
Copy pathREADME.Rmd
File metadata and controls
119 lines (77 loc) · 6.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rminkav5 <a href="https://dplyr.tidyverse.org"><img src="man/figures/logo1.png" align="right" height="138" /></a>
<!-- badges: start -->
[](https://github.com/Raiservi/rminkav5/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/Raiservi/rminkav5)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/Raiservi/rminkav5/commits/main)
<br>
[](https://zenodo.org/records/18909175)
[](https://app.dimensions.ai/details/publication/pub.1165278788)
[](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)
<br>
[](https://github.com/Raiservi/rminkav5)
[](https://github.com/Raiservi/rminkav5/releases)
[](https://github.com/Raiservi/rminkav5/graphs/contributors)
<!-- badges: end -->
## Usage
Minka is a citizen science app built for recording, organizing and sharing naturalistic observations of animals and plants. It allows anyone to become a researcher and that the observations we make serve for scientific use. Minka also allows users to create their own projects. The link to access Minka's website is [https://minka-sdg.org/](https://minka-sdg.org/)
The goals of the `rminka` package are:
1. Directly access the data stored in Minka to be able to process them with R through the API.
1. Treat the data to be able to use them directly with other packages such as `vegan` or `dismo`.
## Overview
`rminkav5` is a toolkit for interacting with the Minka API, providing a consistent set of functions to help you query and retrieve biodiversity data. The package's functions are grouped by the type of data they return:
**a) Project Queries:** A set of complementary functions to find projects and their associated observations.
* `mnk_proj_byname()`: Finds a project's ID using an approximate project name.
* `mnk_proj_info()`: Retrieves detailed project information using its known ID.
* `mnk_proj_obs()`: Fetches all observations for a specific year within that project.
**b) User Queries:** Functions to find users and their contributed observations.
* `mnk_user_byname()`: Finds a user's ID from their approximate login name.
* `mnk_user_proj()`: Find the projects to which a user has explicitly subscribed based on their user_ID.
* `mnk_user_obs()`: Retrieves all observations contributed by that user for a given year ( all the year or only a specific month) from their id_user.
**c) Place Queries:** Functions to find places and retrieve their spatial data.
* `mnk_places_byname()`: Finds the ID for a location using an approximate place name.
* `mnk_place_sf()`: Returns the `sf` geometry for a place, ready for plotting with packages like `ggplot2` or `leaflet`.
**d) Observation Queries:** A variety of functions to fetch observation data based on different parameters.
* `mnk_obs_id()`: Retrieves a single observation's complete data using its unique ID.
* `mnk_obs()`: Fetches observations based on various parameters for a full year, a specific month, or a single day.
* `mnk_obs_bydays()`: Retrieves all observations within a date range in the same year.
**e) Auxiliary functions:** a set of functions with different utilities that complement Minka's observational data and help in processing them when used in other R packages (dismo, vegan,..).
* `get_wrm_tax()`: Retrieves the complete taxonomy and additional information (terrestrial/marine...) of a species given its scientific name.
* `shrt_name()`: Returns the CEP name (abbreviated scientific name) with separation point, given the scientific name.
These functions are designed to be used together. For queries that span multiple years, you can easily loop through the years of interest, run the appropriate function, and then combine the resulting tibbles with `dplyr::bind_rows()`.
## Installation
You can install the development version of rminkav5 from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("Raiservi/rminkav5")
```
## Using rminka
If you are new to `rminka` you are better off starting with a starting web page of `rminka` in the github page of the project.
1. The main page directions is [rminka website](https://development-biomarine.github.io/rminkav3/)
1. The starting web page is [rminka starting](https://development-biomarine.github.io/rminkav3/articles/rminkav3.html)
## Getting help
There are two main places to get help with `rminka`:
1. The [RStudio community][community] is a friendly place to ask any
questions about R.
1. [Stack Overflow][so] is a great source of answers to common R
questions. It is also a great place to get help, once you have
created a reproducible example that illustrates your problem.
[community]: https://forum.posit.co/
[so]: https://stackoverflow.com/
If you encounter a clear bug, please file an issue with a minimal reproducible example on [GitHub](https://github.com/tidyverse/dplyr/issues).
## Code of conduct
Please note that this project is released following a [Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.