report_nan_values

movement.utils.reports.report_nan_values(da, label=None)

Report the number and percentage of data points that are NaN.

The number of NaNs are counted for each element along the required time dimension. If the DataArray has the space dimension, the space dimension is reduced by checking if any values in the space coordinates are NaN, e.g. a 2D point is considered as NaN if any of its x or y coordinates are NaN.

Parameters:

• da (DataArray) – The input data with time as a required dimension.

• label (str | None) – Label to identify the data in the report. If not provided, the name of the DataArray is used. If the DataArray has no name, “data” is used as the label.

Returns:

A string containing the report.

Return type:

str