# 1 Rationale

Tables as places where data are recorded can be pretty messy. The ‘tidy’ paradigm in R proposes that data are organised so that variables are recorded in columns, observations in rows and that there is only one value per cell (Wickham 2014). This, however, is only one interpretation of how data should be organised and especially when scraping data from multiple heterogeneous sources, one frequently encounters messy data that don’t follow this paradigm.

The `tidyr` package is one of the most popular tools to bring data into a tidy format. However, up until today it is limited to tables that are already organised into topologically coherent (rectangular) chunks and any messiness beyond that requires dedicated scripts for reorganisation. In `tabshiftr` we try to describe and work with a further dimension of messiness, where data are available as so-called disorganised (messy) data, data that are not yet arranged into rectangular form.

The approach of `tabshiftr` is based on describing the arrangement of such tables in a so-called schema description, which is then the basis for automatic reorganisation via the function `reorganise()`. Typically there is an input and an output schema, describing the arrangement of the input and output tables, respectively. The advantage of this procedure is that input and output tables exist explicitly and the schema maps the transformation of the data. As we want to end up with tidy tables, the output schema is pre-determined by a tidy table of the included variables and the input schema needs to be put together by you, the user.

# 2 The basics

Data can be disorganised according to multiple dimensions. To understand those dimensions, we first need to understand the nature of data. Data "of the same kind" are collected in a variable, which is always a combination of a name and the values. In a table, names are typically in the topmost row and values are in the column below that name (Tab. 1). Conceptually, there are two types of variables in any table:

1. Variables that contain categorical levels that identify the units for which values have been observed (they are called identifying variables here).
2. Variables that have been measured or observed and that consequently represent the target values of that measurement, be they continuous or categorical (they are called observed variables here).

Moreover, a table is part of a series when other tables of that series contain the same variables, irrespective of how the distinct tables of that series are arranged.

Table 1: An example table containing one identifying and two observed variables, with the variable names in the topmost row and the values in all consecutive rows.
identifying variable observed variable (categorical) observed variable (continuous)
sample 1 blue 10
sample 1 green 20
sample 1 red 30

Even though data in many spreadsheet are "disorganised", they are mostly not non-systematic. Especially in complex spreadsheets, one often encounters a situation where a set of variables occurs more than once with the same or very similar organisation, which we call cluster here. Data that are part of clusters are split up by another, typically categorical variable (the cluster ID), with the aim to increase the visual accessibility or direct the focus for human readers (Tab. 2). This may also be the case where data are split up across several files or spreadsheets of a file, where the cluster ID can be found in the file or spreasheet name or the meta-data. In that case, the cluster ID would be an implicit variable.

Table 2: An example of a table with several clusters of comparable variables.
sample colour intensity sample colour intensity
sample 1 sample 2
blue 10 blue 11
green 20 green 24
red 30 red 13
sample 3 sample 4
blue 20 blue 10
green 15 green 16
red 33 red 21

# 3 How to make a schema description

To set up a schema description, go through the following questions step by step and provide the respective answer in the respective function. Linked tables in the next section can serve as examples to compare against.

1. Variables: Clarify which are the identifying variables and which are the observed variables. Make sure not to mistake a listed observed variable (Tab. 10) as an identifying variable.

2. Meta-data: Provide potentially information about the table format in `setFormat()`.

3. Clusters: In case there are clusters, provide in `setCluster()`

• are data clustered into several files or spreadsheets and is the information used to separate the data (i.e., the spreadsheet name) a variable of interest (Tab. 6) or are the data clustered within one spreadsheet (Tab. 12, Tab. 13, Tab. 14 & Tab. 15)?
• are data clustered according to an identifying variable (Tab. 12, Tab. 13), or are observed variables grouped into clusters (Tab. 14)?
• are clusters nested into a grouping variable of interest (Tab. 15)?

4. Identifying variables: provide in `setIDVar()`

• in which column(s) is the variable?
• is the variable a result of merging several columns (Tab. 4) or must it be split off of another column (Tab. 5)?
• is the variable wide (i.e., its values are in several columns) (Tab. 7, Tab. 8 & Tab. 9)? In this case, the values will look like they are part of the header.
• is the variable distinct from the main table (Tab. 16)?

5. Observed variable: provide in `setObsVar()`

• in which column(s) is the variable?
• is the variable wide and nested in a wide identifying variable (i.e., the name of the observed variable is below the name of the identifying variable) (Tab. 7 & Tab. 9)?
• is the variable listed (i.e., the names of the variable are given as a value of an identifying variable) (Tab. 10)?

As an example, we show here how to build a schema description for a table that has a wide identifying variable and a listed observed variable. This table contains additionally some dummy information one would typically encounter in tables, such as `empty_col`s and rows and data that are not immediately of interest (`other_observed`).

``kable(input <- tabs2shift\$listed_column_wide)``
X1 X2 X3 X4 X5 X6 X7 X8
territories period . dimension other_observed soybean maize empty_col
unit 1 year 1 . harvested xyz 1111 1121 .
unit 1 year 1 . production xyz 1112 1122 .
unit 1 year 2 . harvested xyz 1211 1221 .
unit 1 year 2 . production xyz 1212 1222 .
. . . . . . . .
unit 2 year 1 . harvested xyz 2111 2121 .
unit 2 year 1 . production xyz 2112 2122 .
unit 2 year 2 . harvested xyz 2211 2221 .
unit 2 year 2 . production xyz 2212 2222 .

In this case we don’t need to set clusters and can start immediately with setting the first id variable `territories`, which is in the first column and otherwise tidy. The order by which we set the variables determines where they ocurr in the output table. Any of the setters start by default with an empty schema, in case none is provided to them from a previous setter, thus none needs to be provided at the beginning of a schema.

``schema <- setIDVar(name = "territories", columns = 1)``

Since version 0.3.0, `tabshiftr` comes with getters that allow to debug the current schema description. To do this, however, the schema first needs to be validated. This is in order to make sure that all the generic information are evaluated with the respective input. After that, a getter can be used to extract the respective information, for example the reorganised id variables with `getIDVars()`.

``````validateSchema(schema = schema, input = input) %>%
getIDVars(input = input)
#> [[1]]
#> [[1]]\$territories
#> # A tibble: 9 x 1
#>   X1
#>   <chr>
#> 1 territories
#> 2 unit 1
#> 3 unit 1
#> 4 unit 1
#> 5 unit 1
#> 6 unit 2
#> 7 unit 2
#> 8 unit 2
#> 9 unit 2``````

After seeing that our specification results in a meaningful output, we can continue setting the other id variables `years` (tidy and in column 2) and `commodities` (spread over two columns and the values are in the first row). Note, how we pipe the previous schema into the next setter. This results in the next variable being added to that schema.

``````schema <- schema %>%
setIDVar(name = "year", columns = 2) %>%
setIDVar(name = "commodities", columns = c(6, 7), rows = 1)``````

Validating and checking for id variables again results in the following

``````validateSchema(schema = schema, input = input) %>%
getIDVars(input = input)
#> [[1]]
#> [[1]]\$territories
#> # A tibble: 8 x 1
#>   X1
#>   <chr>
#> 1 unit 1
#> 2 unit 1
#> 3 unit 1
#> 4 unit 1
#> 5 unit 2
#> 6 unit 2
#> 7 unit 2
#> 8 unit 2
#>
#> [[1]]\$year
#> # A tibble: 8 x 1
#>   X2
#>   <chr>
#> 1 year 1
#> 2 year 1
#> 3 year 2
#> 4 year 2
#> 5 year 1
#> 6 year 1
#> 7 year 2
#> 8 year 2
#>
#> [[1]]\$commodities
#> # A tibble: 1 x 2
#>   X6      X7
#>   <chr>   <chr>
#> 1 soybean maize``````

The id variable `commodities` is clearly wide (more than one column) and its’ values are not repeated four times, as it should be, judging by the combination of the other variables. However, this is an expected tentative output that will be handled in a later step and the id variables have been specified correctly.

Next, we set the listed observed variables. Listed means that the column names of the observed variables are treated as if they were the values of an identifying variable (in column 4), while the values are in the columns 6 and 7. Moreover, the values need to be filtered by `value` (in the key in column 4).

``````schema <- schema %>%
setObsVar(name = "harvested", columns = c(6, 7), key = 4, value = "harvested") %>%
setObsVar(name = "production", columns = c(6, 7), key = 4, value = "production")``````

We then get the following observed variables, which is also an expected tentative output.

``````validateSchema(schema = schema, input = input) %>%
getObsVars(input = input)
#> [[1]]
#> [[1]]\$harvested
#> # A tibble: 4 x 2
#>   X6    X7
#>   <chr> <chr>
#> 1 1111  1121
#> 2 1211  1221
#> 3 2111  2121
#> 4 2211  2221
#>
#>
#> [[2]]
#> [[2]]\$production
#> # A tibble: 4 x 2
#>   X6    X7
#>   <chr> <chr>
#> 1 1112  1122
#> 2 1212  1222
#> 3 2112  2122
#> 4 2212  2222``````

The `reorganise()` function carries out the steps of validating, extracting the variables, pivoting the tentative output and putting the final table together automatically, so it merely requires the finalised `schema` and the `input` table.

``````schema # has a pretty print function
#>
#>    variable      type       row   col   key   value
#>   ------------- ---------- ----- ----- ----- ------------
#>    territories   id               1
#>    year          id               2
#>    commodities   id         1     6:7
#>    harvested     observed         6:7   4     harvested
#>    production    observed         6:7   4     production

reorganise(input = input, schema = schema)
#> # A tibble: 8 x 5
#>   territories year   commodities harvested production
#>   <chr>       <chr>  <chr>           <dbl>      <dbl>
#> 1 unit 1      year 1 maize            1121       1122
#> 2 unit 1      year 1 soybean          1111       1112
#> 3 unit 1      year 2 maize            1221       1222
#> 4 unit 1      year 2 soybean          1211       1212
#> 5 unit 2      year 1 maize            2121       2122
#> 6 unit 2      year 1 soybean          2111       2112
#> 7 unit 2      year 2 maize            2221       2222
#> 8 unit 2      year 2 soybean          2211       2212``````

# 4 Table types

In this section we look at some examples of disorganised data, discuss the dimension along which they are disorganised and show which schema description should be used to reorganise them.

To work with `tabshiftr`, tables need to be read in while treating any header rows as data, i.e., by not setting the first row as header, because in disorganised tables it’s often not only the first row that is part of the header. Moreover, each column should be treated as a character data type, because some columns might contain data with both numeric and character cells. `reorganise()` takes care of reformatting the data into the most permissive data type that does not introduce `NA`s where there should be data, i.e, if a variable can be numeric, it is formatted as numeric column.

``````input <- read_csv(file = ...,
col_names = FALSE,
col_types = cols(.default = "c"))``````

All of the following examples contain an `other_observed`, an `empty_col` column and an empty row, which serve the purpose of dummy information or formating that could be found in any table and should not disturb the process of reorganising. You can run all the examples by simply loading the schema and calling `reorganise(input = tabs2shift\$..., schema = schema)` with the respective table that is plotted for this example.

## 4.1 Table contains one cluster

### 4.1.1 Tidy table

In case the observed variables are arranged into individual columns (Tab. 3), we have tidy data (Wickham 2014), which are largely already in the target arrangement. The tidy table may however, still contain unneeded data, need different names, or transformation factors for the values.

``kable(tabs2shift\$tidy)``
Table 3: A largely tidy table.
X1 X2 X3 X4 X5 X6 X7
territories period commodities other_observed harvested production empty_col
unit 1 year 1 soybean xyz 1111 1112 .
unit 1 year 1 maize xyz 1121 1122 .
unit 1 year 2 soybean xyz 1211 1212 .
unit 1 year 2 maize xyz 1221 1222 .
. . . . . . .
unit 2 year 1 soybean xyz 2111 2112 .
unit 2 year 1 maize xyz 2121 2122 .
unit 2 year 2 soybean xyz 2211 2212 .
unit 2 year 2 maize xyz 2221 2222 .
``````schema <-
setIDVar(name = "territories", columns = 1) %>%
setIDVar(name = "year", columns = 2) %>%
setIDVar(name = "commodities", columns = 3) %>%
setObsVar(name = "harvested", columns = 5) %>%
setObsVar(name = "production", columns = 6, factor = 0.1)

reorganise(input = tabs2shift\$tidy, schema = schema)
#> # A tibble: 8 x 5
#>   territories year   commodities harvested production
#>   <chr>       <chr>  <chr>           <dbl>      <dbl>
#> 1 unit 1      year 1 maize            1121       112.
#> 2 unit 1      year 1 soybean          1111       111.
#> 3 unit 1      year 2 maize            1221       122.
#> 4 unit 1      year 2 soybean          1211       121.
#> 5 unit 2      year 1 maize            2121       212.
#> 6 unit 2      year 1 soybean          2111       211.
#> 7 unit 2      year 2 maize            2221       222.
#> 8 unit 2      year 2 soybean          2211       221.``````

### 4.1.2 Mismatch of columns and variables

Sometimes it may be the case that the number variables is not the same as there are columns because either one variable is spread over several column, or one column contains several variables.

In the former case, columns need to be merged (Tab. 4) and in the latter case, columns need to be split via regular expressions (Tab. 5). For example, `.+?(?=_)` gives everything up until the first `_` and `(?<=\\_).*` everything after the `_`.

``kable(input <- tabs2shift\$split_column)``
Table 4: The variables `year` is split up into two columns.
X1 X2 X3 X4 X5 X6 X7 X8
territories timespan other_observed step commodity harvested production empty_col
unit 1 year xyz 1 soybean 1111 1112 .
unit 1 year xyz 1 maize 1121 1122 .
unit 1 year xyz 2 soybean 1211 1212 .
unit 1 year xyz 2 maize 1221 1222 .
. . . . . . . .
unit 2 year xyz 1 soybean 2111 2112 .
unit 2 year xyz 1 maize 2121 2122 .
unit 2 year xyz 2 soybean 2211 2212 .
unit 2 year xyz 2 maize 2221 2222 .
``````schema <-
setIDVar(name = "territories", columns = 1) %>%
setIDVar(name = "year", columns = c(2, 4), merge = " ") %>%
setIDVar(name = "commodities", columns = 5) %>%
setObsVar(name = "harvested", columns = 6) %>%
setObsVar(name = "production", columns = 7)``````
``kable(tabs2shift\$merged_column)``
Table 5: The variables `year` and `commodities` are stored in the same column.
X1 X2 X3 X4 X5 X6
territories unit other_observed harvested production empty_col
unit 1 year 1_soybean xyz 1111 1112 .
unit 1 year 1_maize xyz 1121 1122 .
unit 1 year 2_soybean xyz 1211 1212 .
unit 1 year 2_maize xyz 1221 1222 .
. . . . . .
unit 2 year 1_soybean xyz 2111 2112 .
unit 2 year 1_maize xyz 2121 2122 .
unit 2 year 2_soybean xyz 2211 2212 .
unit 2 year 2_maize xyz 2221 2222 .
``````schema <-
setIDVar(name = "territories", columns = 1) %>%
setIDVar(name = "year", columns = 2, split = ".+?(?=_)") %>%
setIDVar(name = "commodities", columns = 2, split = "(?<=\\_).*") %>%
setObsVar(name = "harvested", columns = 4) %>%
setObsVar(name = "production", columns = 5)``````

### 4.1.3 Implicit variables

When data are split up into clusters that are stored in separate files or spreadsheets, the cluster ID is often recorded not in the table as an explicit variable, but is only provided in the file or table name. In those cases, we have to register this cluster ID as an identifying variable nevertheless, to output a consistent table.

``kable(input <- tabs2shift\$implicit_variable)``
Table 6: The information about which territory we are dealing with is missing or implied by some meta-data.
X1 X2 X3 X4
here would be some metadata, which does however not tell us that this is in fact unit 1 . . .
we get that information from the context, for example the filename . . .
. . . .
commodities harvested production period
soybean 1111 1112 year 1
maize 1121 1122 year 1
soybean 1211 1212 year 2
maize 1221 1222 year 2
``````schema <- setCluster(id = "territories",
left = 1, top = 4) %>%
setIDVar(name = "territories", value = "unit 1") %>%
setIDVar(name = "year", columns = 4) %>%
setIDVar(name = "commodities", columns = 1) %>%
setObsVar(name = "harvested", columns = 2) %>%
setObsVar(name = "production", columns = 3)``````

### 4.1.4 Wide variables

In case identifying variables are factors with a small number of levels, those levels may be falsely used as names of other variables, where they would be next to each other and thus "wide" (Tab. 7). Those other variables (both identifying and observed variables) would then be "nested" in the wide identifying variables. In those cases we have to record for the identifying variable(s) the columns and the row in which the values of the identifying variable are found (they will look like they are part of the header). For the observed variable(s) we need to record also the columns and the topmost row of that variable, i.e., the row in which the name of the nested observed variable is found.

``kable(input <- tabs2shift\$one_wide_id)``
Table 7: The observed variables are nested within the identifying variable `commodities`.
X1 X2 X3 X4 X5 X6 X7 X8
territories . period soybean . maize . empty_col
. . . harvested production harvested production .
unit 1 . year 1 1111 1112 1121 1122 .
unit 1 . year 2 1211 1212 1221 1222 .
. . . . . . . .
unit 2 . year 1 2111 2112 2121 2122 .
unit 2 . year 2 2211 2212 2221 2222 .