Accessing dataset description through plugin API?

[Thomas Castleman]

Hi,

I noticed by clicking the “i” button on the sidebar of a table, you get a “Dataset Information” popup that shows a name, source, import date, and description for the dataset.

Is this information (in particular, the description field) accessible/modifiable through the data interactive plugin API? If so, how? I noticed that data contexts have a description field (documented as currently unused), but I checked and this appears to be separate from what is displayed in the “i” menu.

Thanks

[Jonathan Sandoe]

Hi Thomas,

The description property in the DataContext can be considered to be decremented. The metadata property includes, as you note, a description property, which is visible in the “info” menu in the Case Table. You can retrieve the metadata through the API. You can create a metadata object when you create a data context through the API. You cannot at this time update it through the API.

Jonathan

[Thomas Castleman]

Thank you! I could not find the metadata property in the documentation, but that is indeed what I need.

Thomas

[Thomas Castleman]

Following up–you mentioned it is not currently possible to update the description through the API (and we have observed this behavior). Would it be possible to add this functionality?

This is important for our plugin’s use case, as we use the description to describe a transformed dataset as it relates to the input dataset that created it. When an input dataset’s title changes, we’d like to update the descriptions of the affected outputs accordingly.

Thanks,

Thomas

[Jonathan Sandoe]

I added a bug report documenting this deficiency. We will see if we can get it done soon.

Jonathan

[Thomas Castleman]

Great, thank you!

[Author]

Posts