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
164
165
166
167
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/long_df_and_array.R
\name{array_df_ratetable_utils}
\alias{array_df_ratetable_utils}
\alias{long_df_to_array}
\alias{long_df_to_ratetable}
\alias{long_dt_to_array}
\alias{long_dt_to_ratetable}
\alias{array_to_long_df}
\alias{array_to_long_dt}
\alias{array_to_ratetable}
\alias{ratetable_to_array}
\alias{ratetable_to_long_df}
\alias{ratetable_to_long_dt}
\title{\code{array}s, \code{data.frame}s and \code{ratetable}s}
\usage{
long_df_to_array(x, stratum.col.nms, value.col.nm)
long_df_to_ratetable(
x,
stratum.col.nms,
value.col.nm,
dim.types,
cut.points = NULL
)
long_dt_to_array(x, stratum.col.nms, value.col.nm)
long_dt_to_ratetable(
x,
stratum.col.nms,
value.col.nm,
dim.types,
cut.points = NULL
)
array_to_long_df(x)
array_to_long_dt(x)
array_to_ratetable(x, dim.types, cut.points = NULL)
ratetable_to_array(x)
ratetable_to_long_df(x)
ratetable_to_long_dt(x)
}
\arguments{
\item{x}{\verb{[data.frame, data.table, array, ratetable]} (mandatory, no default)
\itemize{
\item \code{long_df_to_array}: a \code{data.frame}
\item \code{long_df_to_ratetable}: a \code{data.frame}
\item \code{long_dt_to_array}: a \code{data.table}
\item \code{long_dt_to_ratetable}: a \code{data.table}
\item \code{array_to_long_df}: an \code{array}
\item \code{array_to_long_dt}: an \code{array}
\item \code{array_to_ratetable}: an \code{array}
\item \code{ratetable_to_array}: a \link[survival:ratetable]{survival::ratetable}
\item \code{ratetable_to_long_df}: a \link[survival:ratetable]{survival::ratetable}
\item \code{ratetable_to_long_dt}: a \link[survival:ratetable]{survival::ratetable}
}}
\item{stratum.col.nms}{\verb{[character]} (mandatory, no default)
a vector of column names in \code{x} by which values are stratified}
\item{value.col.nm}{\verb{[character]} (mandatory, no default)
name of column in \code{x} containing values (these will be contents of the
array)}
\item{dim.types}{\verb{[integer]} (mandatory, no default)
see \code{type} under \strong{Details} in \link[survival:ratetable]{survival::ratetable}}
\item{cut.points}{\verb{[NULL, list]} (optional, default \code{NULL})
see \code{cutpoints} under \strong{Details} in \link[survival:ratetable]{survival::ratetable}
\itemize{
\item \code{NULL}: automatically set using \code{dimnames(x)} and \code{dim.types}
\item \code{list}: one element for each dimensions of \code{x}
}}
}
\value{
\itemize{
\item \code{long_df_to_array}: an \code{array}
\item \code{long_df_to_ratetable}: a \link[survival:ratetable]{survival::ratetable}
\item \code{long_dt_to_array}: an \code{array}
\item \code{long_dt_to_ratetable}: a \link[survival:ratetable]{survival::ratetable}
\item \code{array_to_long_df}: an \code{data.frame}
\item \code{array_to_long_dt}: an \code{data.table}
\item \code{array_to_ratetable}: a \link[survival:ratetable]{survival::ratetable}
\item \code{ratetable_to_array}: an \code{array}
\item \code{ratetable_to_long_df}: a \code{data.frame}
\item \code{ratetable_to_long_dt}: a \code{data.table}
}
}
\description{
Utilities to transform objects between \code{array}, \code{data.frame}, and
\link[survival:ratetable]{survival::ratetable}.
}
\details{
\itemize{
\item \code{long_df_to_array}: converts a long-format \code{data.frame} to an \code{array}
with one or more dimensions
}
\itemize{
\item \code{long_df_to_ratetable}: calls \code{long_df_to_array} and then
\code{array_to_ratetable}
}
\itemize{
\item \code{long_dt_to_array}: simply asserts that \code{x} is a \code{data.table} and
calls \code{long_df_to_array}
}
\itemize{
\item \code{long_dt_to_ratetable}: calls \code{long_dt_to_array} and then
\code{array_to_ratetable}
}
\itemize{
\item \code{array_to_long_df}: converts an array with one or more dimensions into
a long-format \code{data.frame}; any \link{dimnames} are used to name and fill the
stratifying columns; for dimensions without a name, \code{".dX"} is used
for stratifying column number \code{X}; for each \code{k}, if there are no contents
in \code{dimnames(x)[[k]]}, the elements of \code{seq(dim(x)[k])} are used to fill
the corresponding stratifying column; the value column always has the name
\code{"value"}
}
\itemize{
\item \code{array_to_long_dt}: calls \code{array_to_long_df} and converts result to a
\code{data.table} for convenience
}
\itemize{
\item \code{array_to_ratetable}: converts an array to a \link[survival:ratetable]{survival::ratetable}
}
\itemize{
\item \code{ratetable_to_array}: converts a \link[survival:ratetable]{survival::ratetable} to an array
}
\itemize{
\item \code{ratetable_to_long_df}: calls \code{ratetable_to_array} and then
\code{array_to_long_df}
}
\itemize{
\item \code{ratetable_to_long_dt}: calls \code{ratetable_to_array} and then
\code{array_to_long_dt}
}
}
\examples{
long_dt <- popEpi::popmort
arr <- long_df_to_array(long_dt, c("agegroup", "year", "sex"), "haz")
rt <- array_to_ratetable(arr, dim.types = c(2L, 4L, 1L))
arr2 <- ratetable_to_array(rt)
long_df2 <- array_to_long_df(arr2)
identical(sort(long_dt[["haz"]]), sort(long_df2[["value"]]))
}
|
