-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
95 lines (67 loc) · 3.3 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
94
95
---
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%"
)
#library(sequentially)
```
# sequentially <img src="man/figures/logo.png" align="right" height="250" alt="" />
<!-- badges: start -->
[](https://CRAN.R-project.org/package=sequentially)
[](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress)
[](https://app.codecov.io/gh/jpmonteagudo28/sequentially)
<!-- badges: end -->
This package is born out of curiosity rather than necessity. `sequentially` creates non-linear and linear numeric sequences. By using non-linear interpolation the user can animate their data
in a way that is more visually pleasing than uniform, linear interpolation. The functions in this package represent a break from the **essential** but *boring* `seq()` family of functions–I wanted to plot numeric sequences that looked different and could be used in data visualization, motion animation, frame interpolation, UI/UX design, population dynamics, or other fields.
## Installation
You can install the development version of sequentially like so:
``` r
devtools::install_github("jpmonteagudo28/sequentially")
```
or download it from CRAN:
```r
install.packages("sequentially")
```
## What you get:
This is a basic example which shows you how to solve a common problem:
```{r example}
library(sequentially)
# Linear sequence from 0 to 10
t <- seq(0,1,length.out = 100)
lin_seq <- seq_smooth(0, 10, n = 100, type = "linear")
plot.new()
plot.window(range(t),range(lin_seq))
points(t,lin_seq,pch = 16, cex = .75,col = "red")
axis(1,tcl = 0.75,lwd = 0, family = "serif")
axis(2,lwd = 0, family = "serif", las = 1)
grid(2,col = "gray80",lty = "dotted", lwd = 0.50)
mtext("Linear Sequence",3,cex = 1.3, family = "serif")
# Elastic easing out sequence
elastic_seq <- seq_smooth(0, 10, n = 100, type = "elastic", ease = "out")
plot.new()
plot.window(range(t),range(elastic_seq))
points(t,elastic_seq,pch = 16, cex = .75,col = "red")
axis(1,tcl = 0.75,lwd = 0, family = "serif")
axis(2,lwd = 0, family = "serif", las = 1)
grid(2,col = "gray80",lty = "dotted", lwd = 0.50)
mtext("Ease-out Elastic Sequence",3,cex = 1.3, family = "serif")
```
What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
```{r cars}
```
You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
You can also embed plots, for example:
```{r pressure, echo = FALSE}
```
## Related Software
* [tweenr](https://cran.r-project.org/web/packages/tweenr/tweenr.pdf) - an R package dealing with data animation.
* [displease](https://github.com/coolbutuseless/displease) - a related package used as inspiration for this one.
* [ofpennereasing](https://github.com/jesusgollonet/ofpennereasing) - Rcpp files containing Robert Penner's easing functions