File: as.tbl_cube.Rd

package info (click to toggle)
r-cran-cubelyr 1.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 332 kB
  • sloc: sh: 12; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 1,179 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cube.R
\name{as.tbl_cube}
\alias{as.tbl_cube}
\alias{as.tbl_cube.array}
\alias{as.tbl_cube.table}
\alias{as.tbl_cube.matrix}
\alias{as.tbl_cube.data.frame}
\title{Coerce an existing data structure into a \code{tbl_cube}}
\usage{
as.tbl_cube(x, ...)

\method{as.tbl_cube}{array}(
  x,
  dim_names = names(dimnames(x)),
  met_name = deparse(substitute(x)),
  ...
)

\method{as.tbl_cube}{table}(x, dim_names = names(dimnames(x)), met_name = "Freq", ...)

\method{as.tbl_cube}{matrix}(
  x,
  dim_names = names(dimnames(x)),
  met_name = deparse(substitute(x)),
  ...
)

\method{as.tbl_cube}{data.frame}(x, dim_names = NULL, met_name = guess_met(x), ...)
}
\arguments{
\item{x}{an object to convert. Built in methods will convert arrays,
tables and data frames.}

\item{...}{Passed on to individual methods; otherwise ignored.}

\item{dim_names}{names of the dimensions. Defaults to the names of
the \code{\link[=dimnames]{dimnames()}}.}

\item{met_name}{a string to use as the name for the measure.}
}
\value{
A \code{tbl_cube}.
}
\description{
Coerce an existing data structure into a \code{tbl_cube}
}