-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
67 lines (49 loc) · 2.53 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
---
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%",
error = TRUE
)
```
# transx <a href='https://kvasilopoulos.github.io/transx/'><img src='man/figures/logo.png' align="right" height="138" /></a>
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://CRAN.R-project.org/package=transx)
[](https://github.com/kvasilopoulos/transx/actions)
[](https://codecov.io/gh/kvasilopoulos/transx?branch=master)
<!-- badges: end -->
Univariate time series operations that follow an opinionated design. The main principle of `transx` is to keep the number of observations the same. Operations that reduce this number have to fill the observations gap.
## Design Principles
* The input and the output will always be a numeric vector.
* The output retains the same length as the input.
* Uses a filling logic, where `fill` is used to keep the length of vector identical.
### Optional:
* `na.rm`: Which sets`na.rm = TRUE` by default when needed to.
* `keep.attrs`: Which after manipulations the new series would retain the same attributes.
* `display`: Display informative message for the transformation procedure.
## Installation
You can install the development version from [Github](https://github.com/kvasilopoulos/transx).
``` r
remotes::install_github("transx")
```
### Usage
This is a basic example with lagged and leading values. `fill` can be achieved either
by value or by function. The function can be a build-in function such as mean, or median,
that fill-in by a single values, or it can be of the `fill_*` family such as `fill_locf` and
`fill_nocb` that consider the location of the observations before performing the filling.
```{r example, message = FALSE}
library(transx)
x <- c(5,3,2,2,5)
lagx(x)
lagx(x, fill = 1)
lagx(x, fill = mean)
lagx(x, fill = fill_nocb)
```
## Code of Conduct
Please note that the transx project is released with a [Contributor Code of Conduct](https://kvasilopoulos.github.io/transx//CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.