-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
82 lines (67 loc) · 4.75 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
---
output: md_document
html_preview: false
---
<!-- Generated by knitr: do not edit by hand. Please edit the content in README.Rmd -->
# pedometrics: Miscellaneous Pedometric Tools
```{r, echo=FALSE}
library(magrittr)
pkg.info <-
read.dcf(file = "DESCRIPTION", fields = c("Title", "Version", "Date")) %>%
drop()
```
[](http://www.repostatus.org/#active)
[![packageversion](https://img.shields.io/badge/devel%20version-`r pkg.info["Version"]`-firebrick.svg?style=flat-square)](commits/master)
[](https://travis-ci.org/samuel-rosa/pedometrics)
[](https://cran.r-project.org/package=pedometrics)
[](https://cran.r-project.org/web/checks/check_results_pedometrics.html)
[](http://www.rdocumentation.org/packages/pedometrics)
[](http://www.r-pkg.org/pkg/pedometrics)
The __pedometrics__ package was originally created to share the developments of my PhD research project
entitled _Contribution to the Construction of Models for Predicting Soil Properties_ (2012-2016) carried out
under the supervision of Dr Lucia HC Anjos (Universidade Federal Rural do Rio de Janeiro, Brazil), Dr Gustavo
M Vasques (Embrapa Solos, Brazil), and Dr Gerard BM Heuvelink (ISRIC -- World Soil Information, the
Netherlands). The idea of creating a package came from an observation that was bothering me for some time:
several of the pedometric methods that I saw on published scientific papers were not being broadly employed as
I would expect. But why? The answer seemed straightforward: because they were not available as a computer
program ready to be used. This was also making it difficult to reproduce the analyses carried out by others.
Creating a generic package for R -- a popular programming language among pedometricians -- could be a solution.
The current __pedometrics__ package is an implementation of miscellaneous functions for various
pedometric purposes. This includes the calibration of multiple linear regression models, the
computation of summary validation statistics, the generation of plots, the evaluation of the local
quality of a geostatistical model of uncertainty, and so on. Other functions simply extend the
functionalities of or facilitate the usage of functions from other packages that are commonly used
for the analysis of soil data. Among these, one of the functions that I find very useful is
`plotESDA()`. This function creates four plots for exploratory spatial data analysis (ESDA): a
histogram + density plot, a bubble plot, a variogram plot, and a variogram map. The figure below
shows the result for the zinc concentration in the Meuse river data set.
## Installation
The latest stable version of the __pedometrics__ package generally can be installed from the
Comprehensive R Archive Network ([CRAN][cran]).
```R
# Install package pedometrics from CRAN
install.packages(pkgs = "pedometrics")
```
If installation from CRAN fails, you can install the development version of the __pedometrics__
package available on [GitHub][github] using the __remotes__ package. If you are using a
[Windows][windows] machine, however, you will need to install [Rtools][rtools] first.
```R
# Install package pedometrics from GitHub
if (!require(remotes)) {
install.packages(pkgs = "remotes")
}
remotes::install_github(repo = "laboratorio-de-pedometria/pedometrics")
```
[windows]: https://cran.r-project.org/bin/windows/
[rtools]: https://cran.r-project.org/bin/windows/Rtools/
[cran]: https://CRAN.R-project.org/package=pedometrics
[github]: https://github.com/laboratorio-de-pedometria/pedometrics-package
## How to collaborate
We use the *fork & pull* collaborative development model. This means that you have the freedom to make a
parallel copy -- _fork_ -- of this repository, edit the source code as you see fit and then send -- _push_ --
the changes to your personal copy of this repository. You can do all this without asking any permission. In
case the changes that you have made in your personal copy of this repository are interesting and you have the
interest of sharing them with us, then all you have to do is require them to be pushed -- _pull request_ -- to
this repository. After a review of the changes, we will decide if they can be merged -- _merge_ -- with the
source code of this repository.