Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Proposal] Top level temporal resolution field #68

Closed
odscrachel opened this issue May 23, 2023 · 9 comments
Closed

[Proposal] Top level temporal resolution field #68

odscrachel opened this issue May 23, 2023 · 9 comments
Labels
metadata Issues related to common, core metadata proposal New feature or request

Comments

@odscrachel
Copy link
Contributor

What is your proposed change?

To create a top level temporal_resolution field with the following attributes

Title Field name Description Field Type Codelist
Temporal resolution temporal_resolution The unit(s) of time covered by the dataset. array of strings daily, weekly, monthly, annually

Why is this not covered by the existing model?

This replaces temporal_resolution (E.g. "monthly", "daily", "annual", if applies to data.) which appeared in DDH_v0.2.xlsx.

@odscrachel odscrachel added the proposal New feature or request label May 23, 2023
@stufraser1
Copy link
Member

@matamadio what is the use case for this field? I'm not clear on its use in this context at this level. If applicable to hazard, it should be at hazard level, I'm not sure it's relevant to others H V L

@matamadio
Copy link
Contributor

It is not a mandatory attribute, however it was proposed as it could be relevant for:

  • hazard, e.g. annual wildfires, or monthly drought maps
  • exposure, e.g. a collection of annual land use change
  • loss data, e.g. annual losses vs monthly losses

@duncandewhurst
Copy link
Contributor

I think it's fine to have this as an optional field at the top (dataset) level in RDLS based on DCAT's dataset-level temporalResolution property:

Definition: Minimum time period resolvable in the dataset.
Usage note: If the dataset is a time-series this should correspond to the spacing of items in the series. For other kinds of dataset, this property will usually indicate the smallest time difference between items in the dataset.

Presumably, the reason for specifying the minimum time period, rather than a range or list of durations, is that higher resolution data (e.g. daily) can be aggregated to a lower resolution (e.g. monthly). Is there a particular use case for risk data that can't be met by that model?

In terms of modelling, is the proposed codelist (daily, weekly, monthly, annually) sufficient? What about bi-weekly data or data by decade? A better approach might be to follow DCAT's approach of using ISO8601 durations, e.g. P1M for monthly, P1Y for annual, P2W for bi-weekly etc. JSON Schema offers a 'duration' format that can be used to validate that type of data.

@odscrachel odscrachel added the metadata Issues related to common, core metadata label May 30, 2023
@odscjen
Copy link
Contributor

odscjen commented Jun 30, 2023

we decided in #62 (comment) to have a Temporal object in both the 'dataset' top level and at the Resource level to accommodate when a dataset has a range of times with different resources corresponding to each of those different times. (although I know realise the PR to create Temporal only put it into Resource)

Should this temporal resolution field be added to the Temporal object and therefore be available at both dataset and resource level? @stufraser1 @matamadio

@duncandewhurst
Copy link
Contributor

Temporal resolution and temporal coverage are two different concepts so I think this should be a separate field from the temporal (period) object. That's in line with DCAT's approach to modelling the concepts. As for whether it should exist at both dataset and resource level, given that resources in RDLS can be more than just different distributions/representations of the same dataset, I think it should go at resource level.

@stufraser1
Copy link
Member

It is helpful to have an indication of the temporal coverage at the top level because we need to be able to understand the full range of scenarios e.g. 2020, 2030, 2060... in the overall dataset. However, we also need the specific year/range (coverage) referenced at the resource level for whatever single event date or year scenario the resource refers to.
Temporal resolution probably sits at top level too, given use case where it would describe the collection, not individual file, see #68 (comment), but wouldn't be needed at resource level, I think.

@duncandewhurst
Copy link
Contributor

In #54 we established that resources can be more than just different distributions/representaitons of the same dataset. In particular, we're allowing temporal coverage to differ between resources so we could have a situation in which a dataset has a resource covering 2014 whose temporal resolution is monthly and a resource covering 2015 whose temporal resolution is weekly. In that case, presumably, we'd set the dataset-level temporal resolution field to 'weekly' since that is the minimum temporal resolution resolvable amongst the dataset's resources. However, that's not terribly helpful to users, since the 2014 resource's temporal resolution is actually only monthly. That is why I now think that it makes more sense to have temporal resolution at the resource level.

@odscjen
Copy link
Contributor

odscjen commented Jul 4, 2023

Is the answer to this maybe to have temporal resolution at both the dataset and resource level but similar to how we've agreed to do with hazard event_set vs event include in the description of temporal resolution at the dataset level that this should only be used it the temporal resolution is the same for all resources included, otherwise the resource level temporal resolution field should be used?

@matamadio
Copy link
Contributor

Agreed on Jen proposal to use the top level, unless resources have different resolutions - then use the resource level.

@odscjen odscjen closed this as completed Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
metadata Issues related to common, core metadata proposal New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants