Extract the structure of a dataset

Source: R/get_structure.R

This function extracts the structure and content of a data.frame, storing the following information:

get_structure(x, columns = TRUE)

Arguments

x

a data.frame to be checked
columns

the names or indices of columns to compare. Defaults to TRUE which will keep all columns by default.

Value

A list containing:

  • dim: the dimensions of the dataset (rows, columns)

  • names: the names of the dataset

  • classes: the corresponding classes (if a column has several classes, only the first one is kept)

  • values: the list of sorted, unique values for each categorical column (factor or character)

Details

  • names and order of columns

  • class of the columns

  • values of the columns, for factors and characters

Examples


head(iris)
#>   Sepal.Length Sepal.Width Petal.Length Petal.Width Species
#> 1          5.1         3.5          1.4         0.2  setosa
#> 2          4.9         3.0          1.4         0.2  setosa
#> 3          4.7         3.2          1.3         0.2  setosa
#> 4          4.6         3.1          1.5         0.2  setosa
#> 5          5.0         3.6          1.4         0.2  setosa
#> 6          5.4         3.9          1.7         0.4  setosa
get_structure(iris)
#> $dim
#> [1] 150   5
#> 
#> $names
#> [1] "Sepal.Length" "Sepal.Width"  "Petal.Length" "Petal.Width"  "Species"     
#> 
#> $classes
#> Sepal.Length  Sepal.Width Petal.Length  Petal.Width      Species 
#>    "numeric"    "numeric"    "numeric"    "numeric"     "factor" 
#> 
#> $values
#> $values$Species
#> [1] "setosa"     "versicolor" "virginica" 
#> 
#> 
#> attr(,"class")
#> [1] "data_structure"