-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
163 lines (119 loc) · 5.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
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
---
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%"
)
```
# newdata <img src="man/figures/logo.png" align="right" alt= "Poisson Consulting logo"/>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/poissonconsulting/newdata/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/poissonconsulting/newdata)
[](https://opensource.org/license/mit)
[](https://cran.r-project.org/package=newdata)
<!-- badges: end -->
## Introduction
`newdata` is an R package to generate new data frames by varying some variables while holding the others constant.
By default, all specified variables vary across their range
while all other variables are held constant at a reference value.
The user can specify the length of each sequence, require that only
observed values and combinations are used and add new variables.
Types, classes, factor levels and time zones are always preserved.
Consider the following observed 'old' data frame.
```{r}
library(newdata)
newdata::old_data
```
### Reference Value
By default all variables are set to a reference value.
```{r}
xnew_data(old_data)
```
The reference value depends on the class of the variable, by default:
- logical vectors are FALSE;
- double vectors are the mean;
- integer, Date, POSIXct and hms vectors are the floored mean;
- character vectors are the most common value or the first when sorted of the most common values;
- factor and ordered vectors are the first level.
### Sequences
Specifying a variable causes it to vary sequentially across its range.
```{r}
xnew_data(old_data, int)
```
By default the sequence depends on the class of the variable:
- logical vectors are length 2 (TRUE and FALSE);
- double vectors are 30 equally spaced values from the minimum value to the maximum value;
- integer, Date, POSIXct and hms vectors are up to 30 discrete values from the minimum to the maximum value as evenly spaced as possible;
- character vectors are the number of unique values.
- factor and ordered vectors are the number of levels.
These values can be overridden by setting the following options:
- `new_data.length_out_lgl`, which is 2 by default, for logical vectors;
- `new_data.length_out_dbl`, which is 30 by default, for double vectors;
- `new_data.length_out_int`, which is 30 by default, for integer, Date, POSIXct and hms vectors^1;
- `new_data.length_out_chr`, which is Inf by default, for character, factor and ordered vectors.
1. The length of Date, POSIXct and hms sequences are controlled by `new_data.length_out_int` as they are treated as integers for the purpose of generating a sequence.
When programming it is strongly recommended that the user explicitly specify the length of each sequence individually.
```{r}
xnew_data(old_data, lgl, xnew_seq(int, length_out = 3))
```
A third alternative is to specify the length of all the sequences in the data set but this can result in less common character strings or later factor or ordered levels being dropped.
```{r}
xnew_data(old_data, dbl, int, .length_out = 2)
```
### Observed Values
The user can also indicate whether only observed values should be used in the sequence.
```{r}
xnew_data(old_data, xnew_seq(int, length_out = 3, obs_only = TRUE))
```
The `xobs_only()` function can be used to filter out unobserved values after the sequence has been generated.
```{r}
xnew_data(old_data, xobs_only(xnew_seq(int, length_out = 3)))
```
and when two or more variables are specified all combinations are used.
```{r}
xnew_data(old_data, int, fct)
```
to only get observed combinations.
```{r}
xnew_data(old_data, xobs_only(int, fct))
```
### Modifying Variables
Modifying an existing variable or changing an existing one is simple.
```{r}
xnew_data(old_data, lgl = median(lgl, na.rm = TRUE), extra = c(TRUE, FALSE))
```
### Casting Variables
Casting variables to be the same class as the original is achieved as follows.
```{r}
xnew_data(old_data, xcast(lgl = 1, int = 7, dbl = 10L, fct = "a rarity", hms = "00:00:02"))
```
### A Simple Wrapper
Although superseded, for consistency with existing code `new_data()` which is a simple wrapper on `xnew_data()` allows the user to pass a character vector and to specifying the length of all the sequences is also provided.
```{r}
new_data(old_data, seq = c("int", "fct"), length_out = 5)
```
## Installation
To install the latest release version from CRAN.
```r
install.packages("newdata")
```
To install the latest development version from [GitHub](https://github.com/poissonconsulting/newdata)
```r
# install.packages("pak")
pak::pak("poissonconsulting/newdata")
```
or from [r-universe](https://poissonconsulting.r-universe.dev/newdata).
```r
install.packages("newdata", repos = c("https://poissonconsulting.r-universe.dev", "https://cloud.r-project.org"))
```
## Contribution
Please report any [issues](https://github.com/poissonconsulting/newdata/issues).
[Pull requests](https://github.com/poissonconsulting/newdata/pulls) are always welcome.
## Code of Conduct
Please note that the newdata project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.