-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
51 lines (37 loc) · 1.72 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
---
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%"
)
```
# empichar
<!-- badges: start -->
[](https://app.codecov.io/gh/gbasulto/empichar?branch=master)
[](https://cran.r-project.org/package=empichar)
<!-- badges: end -->
<!-- -->
The goal of empichar is to evaluate the empirical characteristic function meeting the following criteria:
1. Allow the `C++` functions to be imported in other `R` packages.
1. Make a fast evaluation (using `RcppArmadillo`).
1. Check the dimensions of the input arguments.
1. If desired, compute only the real part, imaginary part or modulus of the empirical characteristic function (faster than taking the real part of the empirical characteristic function).
## Installation
You can install the released version of empichar from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("empichar")
```
## Available functions
| Function | Description |
| :--- | :---- |
| `ecf` | Empirical characteristic function of a given sample|
| `ecf_real` | Real part of the empirical characteristic function |
| `ecf_imag` | Imaginary part of the empirical characteristic function |
| `ecf_mod` | Modulus of the empirical characteristic function |
## Documentation
I will add a vignette later on. Meanwhile, consult the documentation with `help("ecf", "empichar")`, `help("ecf_real", "empichar")`, `help("ecf_imag", "empichar")`, `help("ecf_mod", "empichar")`.