|
| 1 | +# Data Tidying |
| 2 | + |
| 3 | +Array data that are represented by Xarray objects are often multivariate, multi-dimensional, and very complex. Part of the beauty of Xarray is that it is adaptable and scalable to represent a large number of data structures. However, this can also introduce difficulty (especially for learning users) in arriving at a workable structure that will best suit one's analytical needs. |
| 4 | + |
| 5 | +```{seealso} |
| 6 | +Look for examples [here](05.2_examples.md) |
| 7 | +``` |
| 8 | + |
| 9 | +This project is motivated by community sentiment and experiences that often, the hardest part of learning and teaching Xarray is teaching users how best to use Xarray conceptually. We hope to leverage the experiences of Xarray and geospatial data users to arrive at a unifying definition of 'tidy' data in this context and best practices for 'tidying' geospatial raster data represented by Xarray objects. |
| 10 | + |
| 11 | +This page discusses common data ‘tidying’ steps and presents principles to keep in mind when organizing data in Xarray. We also point out helpful extensions to simplify and automate this process for specific dataset types like satellite imagery. |
| 12 | + |
| 13 | +A great first step is familiarizing yourself with the [terminology](https://docs.xarray.dev/en/stable/user-guide/terminology.html) used in the Xarray ecosystem. |
| 14 | + |
| 15 | +## A brief primer on tidy data |
| 16 | + |
| 17 | +Tidy data was developed by Hadley Wickham for tabular datasets in the R programming language. Many resources comprehensively explain this concept and the ecosystem of tools built upon it. Below is a very brief explanation: |
| 18 | + |
| 19 | +**Data tidying** is the process of structuring datasets to facilitate analysis. Wickham writes: "...tidy datasets are all alike, but every messy dataset is messy in its own way. Tidy datasets provide a standardized way to link the structure of a dataset (its physical layout) with its semantics (its meaning)" (Wickham, 2014). |
| 20 | + |
| 21 | +### Tidy data principles for tabular datasets |
| 22 | + |
| 23 | +The concept of [tidy data](https://vita.had.co.nz/papers/tidy-data.pdf) was developed by Hadley Wickham in the R programming language, and is a set of principles to guide facilitating tabular data for analysis. |
| 24 | + |
| 25 | +{attribution="Wickham, 2014"} |
| 26 | + |
| 27 | +> "Tidy datasets are all alike, but every messy dataset is messy in its own way." |
| 28 | +
|
| 29 | +Wickham defines three core principles of tidy data for tabular principles. They are: |
| 30 | + |
| 31 | +1. Each variable forms an observation |
| 32 | +2. Each observation forms a row |
| 33 | +3. Each type of observational unit forms a table |
| 34 | + |
| 35 | +## Imagining a 'tidy data' framework for gridded datasets |
| 36 | + |
| 37 | +### Common use-case: Manipulating individual observations to an x-y-time datacube |
| 38 | + |
| 39 | +Data downloaded or accessed from DAACs and other providers is often (for good reason) separated into temporal observations or spatial subsets. This minimizes the services that must be provided for different datasets and allows the user to access just the material that they need. However, most workflows will involve some sort of spatial and/or temporal investigation of an observable, which will usually require the analyst to arrange individual files into spatial mosaics and/or temporal cubes. In addition to being a source of duplicated effort and work, these steps also introduce decision-points that can be stumbling blocks for newer users. We hope a tidy framework for xarray will streamline the process of preparing data for analysis by providing specific expectations of what 'tidied' datasets look like as well as common patterns and tools to use to arrive at a tidy state. |
| 40 | + |
| 41 | +## Tidy data principles for Xarray data structures |
| 42 | + |
| 43 | +These are guidelines to keep in mind while you are organizing your data. For detailed definitions of the terms mentioned below (and more), check out Xarray's [Terminology page](https://docs.xarray.dev/en/stable/user-guide/terminology.html). |
| 44 | + |
| 45 | +**1. Dimensions** |
| 46 | + |
| 47 | +- Minimize the number of dimensional coordinates |
| 48 | + |
| 49 | +**2. Coordinates** |
| 50 | + |
| 51 | +- Non-dimensional coordinates can be numerous. Each should exist along one or multiple dimensions |
| 52 | + |
| 53 | +**3. Data Variables** |
| 54 | + |
| 55 | +- Data variables should be observables rather than contextual. Each should exist along one or multiple dimensions. |
| 56 | + |
| 57 | +**4. Contextual information (metadata)** |
| 58 | + |
| 59 | +- Metadata should only be stored as an attribute if it is static along the dimensions to which it is applied. |
| 60 | +- If metadata is dynamic, it should be stored as a coordinate variable. |
| 61 | +- Metadata `attrs` should be added such that dataset is self-describing (following CF-conventions) |
| 62 | + |
| 63 | +**5. Variable, attribute naming** |
| 64 | + |
| 65 | +- **Wherever possible, use cf-conventions for naming** |
| 66 | +- Variable names should be descriptive |
| 67 | +- Variable names should not contain information that belongs in a dimension or coordinate (ie. information stored in a variable name should be reduced to only the observable the variable describes. |
| 68 | + |
| 69 | +**6. Make us of & work within the framework of other tools** |
| 70 | + |
| 71 | +- Specification systems such as [CF](https://cfconventions.org/) and [STAC](https://stacspec.org/en), and related tools such as [Open Data Cube](https://www.opendatacube.org/), [PySTAC](https://pystac.readthedocs.io/en/stable/), [cf_xarray](https://cf-xarray.readthedocs.io/en/latest/),[stackstac](https://stackstac.readthedocs.io/en/latest/) and more make tidying possible and smoother, especially with large, cloud-optimized datasets. |
| 72 | +- |
| 73 | + |
| 74 | +## Other guidelines and rules of thumb |
| 75 | + |
| 76 | +- Avoid storing important data in filenames |
| 77 | +- Non-descriptive variable names can create + perpetuate confusion |
| 78 | +- Missing coordinate information makes datasets harder to use |
| 79 | +- Elements of a dataset's 'shape'/structure can sometimes be embedded in variable names; this will complicate subsequent analysis |
| 80 | + |
| 81 | +## Contributing |
| 82 | + |
| 83 | +We would love your help and engagement on this project! If you have a dataset that you've worked with that felt particularly messy, or one with steps you find yourself thinking back to as you work with new datasets, consider submitting it as an example! If you have input on tidy principles, please feel free to raise an issue. |
0 commit comments