-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
93 lines (52 loc) · 3.87 KB
/
README.Rmd
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
---
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/",
out.width = "100%")
```
rutils <img src="man/figures/package-sticker.png" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://github.com/frbcesab/rutils/actions/workflows/R-CMD-check.yaml)
[](https://github.com/frbcesab/rutils/actions/workflows/pkgdown.yaml)
[](https://github.com/frbcesab/rutils/actions/workflows/test-coverage.yaml)
[](https://codecov.io/gh/frbcesab/rutils)
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
The R package `rutils` is a collection of R functions commonly used in FRB-CESAB projects.
## Installation
You can install the development version from [GitHub](https://github.com/) with:
```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("frbcesab/rutils")
```
Then you can attach the package `rutils`:
```{r eval = FALSE}
library("rutils")
```
## Overview
- [`get_phylopic_image()`](https://frbcesab.github.io/rutils/reference/get_phylopic_image.html): downloads a silhouette from the [PhyloPic](https://www.phylopic.org/) database using the [PhyloPic API 2.x.x](http://api-docs.phylopic.org/v2/)
- [`get_world_basemap()`](https://frbcesab.github.io/rutils/reference/get_world_basemap.html): downloads a spatial layer of world countries boundaries as defined by the IPBES
- [`leading_zero()`](https://frbcesab.github.io/rutils/reference/leading_zero.html): adds leading zeros to a vector
- [`multi_merge()`](https://frbcesab.github.io/rutils/reference/multi_merge.html): combines different matrices by row names and column names by performing a 2-dimension full join
- [`to_binomial_name()`](https://frbcesab.github.io/rutils/reference/to_binomial_name.html): corrects species binomial name case
- [`address_to_coords()`](https://frbcesab.github.io/rutils/reference/address_to_coords.html): gets geographic coordinates of any location in the World
- [`coords_to_address()`](https://frbcesab.github.io/rutils/reference/coords_to_address.html): retrieve any location in the World from geographic coordinates
- [`rename_col()`](https://frbcesab.github.io/rutils/reference/rename_col.html): Rename any columns of a dataframe (from 1 to as much columns as you want)
- [`signi()`](https://frbcesab.github.io/rutils/reference/signi.html): Produce produces significance symbols for the values of p
- [`plot_2d_img()`](https://frbcesab.github.io/rutils/reference/plot_2d_img.html): Plot two variables using images png as points
- [`hiking_time()`](https://frbcesab.github.io/rutils/reference/hiking_time.html): Hiking time calculation
## Contribution
Visit the [wiki](https://github.com/FRBCesab/rutils/wiki/How-to-contribute) to learn how to contribute to this project.
## Citation
Please cite this package as:
> Casajus N. (`r format(Sys.Date(), "%Y")`) `rutils`: A collection of R functions
commonly used in FRB-CESAB projects. R package version 0.0.0.9000. <https://frbcesab.github.io/rutils>.
## Code of Conduct
Please note that the `rutils` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.