-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
73 lines (56 loc) · 3.93 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
---
output:
github_document:
pandoc_args: --webtex
---
<!-- 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%"
)
```
<!-- badges: start -->
[![R-CMD-check](https://github.com/Jaimemosg/EstimationTools/workflows/R-CMD-check/badge.svg)](https://github.com/Jaimemosg/EstimationTools/actions)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/Jaimemosg/EstimationTools?branch=master&svg=true)](https://ci.appveyor.com/project/Jaimemosg/EstimationTools)<!-- [![Codecov test coverage](https://codecov.io/gh/Jaimemosg/EstimationTools/branch/master/graph/badge.svg)](https://codecov.io/gh/Jaimemosg/EstimationTools?branch=master) -->
[![Codecov test coverage](https://codecov.io/gh/Jaimemosg/EstimationTools/branch/master/graph/badge.svg)](https://app.codecov.io/gh/Jaimemosg/EstimationTools?branch=master)
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version-ago/EstimationTools)](https://cran.r-project.org/package=EstimationTools)
[![CRAN\_Download\_Badge](http://cranlogs.r-pkg.org/badges/EstimationTools)](https://cran.r-project.org/package=EstimationTools)
[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[![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)
[![Licence](https://img.shields.io/badge/licence-GPL--3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
<!-- [![Travis build status](https://travis-ci.org/Jaimemosg/EstimationTools.svg?branch=master)](https://travis-ci.org/Jaimemosg/EstimationTools) -->
<!-- [![Dependencies](https://tinyverse.netlify.com/badge/EstimationTools)](https://cran.r-project.org/package=EstimationTools) -->
<!-- badges: end -->
# EstimationTools <img src="man/figures/ETLogo.png" align="right" height="200" style="float:right; height:200px;"/>
<!-- <img src="man/figures/ETLogo.png" align="right" height="200"/> -->
The goal of `EstimationTools` is to provide tools and routines for maximum likelihood estimation of probability density/mass functions in `R`.
<!-- _Edit (17/03/2021)_ -- We have performed a TTT plot implementation. You can find out in our [changelog](https://jaimemosg.github.io/EstimationTools/news/index.html). -->
<!-- _Edit (27/07/2020)_ -- We have implemented new tools and we have performed some deep modifications in our `summary` method for `maxlogL` objects. You can find out in our [changelog](https://jaimemosg.github.io/EstimationTools/news/index.html). -->
## Installation
```{r, echo=FALSE, message=FALSE, warning=FALSE, include=FALSE}
file <- readtext::readtext('DESCRIPTION')
text <- file$text
mysubstring <- regmatches(text, gregexpr("\nVersion:(.+)\n", text, perl = TRUE))
split1 <- strsplit(mysubstring[[1]], split = '\n')
split2 <- strsplit(split1[[1]][2], split = ' ')
myversion <- split2[[1]][2]
```
You can install the latest version (`r myversion`) of `EstimationTools` typing the following command lines
in `R` console:
``` {r eval=FALSE}
if (!require('devtools')) install.packages('devtools')
devtools::install_github('Jaimemosg/EstimationTools', force = TRUE)
library(EstimationTools)
```
<!-- `r utils::packageVersion("EstimationTools")` -->
Or you can install the released version (4.0.0) from [CRAN](https://cran.r-project.org/package=EstimationTools) if you prefer. You can also type the following command lines
in `R` console:
```{r eval=FALSE}
install.packages("EstimationTools")
```
You can visit the [package website](https://Jaimemosg.github.io/EstimationTools/) to explore the functions reference and our vignettes (articles).
## Examples
You can visit our estimation [vignette](https://jaimemosg.github.io/EstimationTools/articles/Examples.html) to see the examples.