Remove unvetted DataTree methods #9585
Conversation
As [discussed](https://docs.google.com/presentation/d/1zBjEsihBhK_U972jxHwaAZBbzS1-hd3aDLnO9uu2Ob4/edit#slide=id.g3087b787633_13_0) in the last DataTree meeting, this PR deletes the many Dataset methods that were copied onto DataTree without unit tests, along with a few that are not implemented properly yet, e.g., 1. Arithmetic methods were removed, because `DataTree + Dataset` should probably raise an error. 2. Indexing and aggregation methods were removed, because these should allow for dimensions that are missing only on some nodes. 3. The untested `map_over_subtree_inplace` and `render` methods were removed. 3. A few other methods (e.g., `merge` and `plot`) that were only implemented by raising `NotImplementedError`` are entirely removed instead.
|
I have an implementation of |
|
Reimplemented aggregations also coming soon... |
|
I've commented out the parts of the doc that reference removed DataTree methods. This is ready for review now. |
TomNicholas
added
the
topic-DataTree
xref #9365 (comment)
xref #8949
👍
|
|
|
||
| .. DataTree.assign_coords | ||
| .. DataTree.merge | ||
| .. DataTree.rename | ||
| .. DataTree.rename_vars | ||
| .. DataTree.rename_dims | ||
| .. DataTree.swap_dims | ||
| .. DataTree.expand_dims | ||
| .. DataTree.drop_vars | ||
| .. DataTree.drop_dims | ||
| .. DataTree.set_coords | ||
| .. DataTree.reset_coords |
There was a problem hiding this comment.
Was the decision here that these methods should act locally rather than mapping over the subtree? And the distinction being between methods which manipulate structure versus methods which manipulate data - the latter map over the whole tree?
| .. DataTree.reindex | ||
| .. DataTree.reindex_like | ||
| .. DataTree.set_index | ||
| .. DataTree.reset_index |
There was a problem hiding this comment.
Unclear to me whether these methods would count as "manipulating structure" or "manipulating data"...
| .. Missing: | ||
| .. ``DataTree.loc`` |
There was a problem hiding this comment.
There are some other methods mentioned in the API docs page as "Missing:" - these references should also be commented out or deleted.
| We intend to eventually implement most :py:class:`~xarray.Dataset` methods | ||
| (indexing, aggregation, arithmetic, etc) on :py:class:`~xarray.DataTree` | ||
| objects, but many methods have not been implemented yet. |
There was a problem hiding this comment.
Put this in a note
| We intend to eventually implement most :py:class:`~xarray.Dataset` methods | |
| (indexing, aggregation, arithmetic, etc) on :py:class:`~xarray.DataTree` | |
| objects, but many methods have not been implemented yet. | |
| .. note:: | |
| We intend to eventually implement most | |
| :py:class:`~xarray.Dataset` methods | |
| (indexing, aggregation, arithmetic, | |
| etc) on :py:class:`~xarray.DataTree` | |
| objects, but many methods have not been | |
| implemented yet. |
This PR deletes the many Dataset methods that were copied onto DataTree without unit tests, along with a few that are not implemented properly yet, e.g.,
DataTree + Datasetshould probably raise an error.map_over_subtree_inplaceandrendermethods were removed.mergeandplot) that were only implemented by raising `NotImplementedError`` are entirely removed instead.