GH-38166: [MATLAB] Improve tabular object display #38482
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to arrow.internal.display package
…display.getTabular
….display.getSchemaString
2. Add "Arrow" prefix to header
|
|
kou
changed the title
kevingurney
approved these changes
Oct 27, 2023
|
+1 |
github-actions
bot
added
awaiting merge
|
After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 547b240. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. |
loicalleyne
pushed a commit
to loicalleyne/arrow
that referenced
this pull request
Nov 13, 2023
### Rationale for this change
Currently, the display for `arrow.tabular.RecordBatch` and `arrow.tabular.Table` are not very MATLAB-like.
### What changes are included in this PR?
1. Updated the display of both `arrow.tabular.Table` and `arrow.tabular.RecordBatch`.
2. Added a new utility function `arrow.internal.display.boldFontIfPossible`
3. Renamed `arrow.array.internal.display.pluralizeStringIfNeeded` to `arrow.internal.display.pluralizeStringIfNeeded`
4. Renamed `arrow.tabular.internal.displaySchema` to `arrow.tabular.internal.display.getSchemaString`.
**Example RecordBatch Display**
```matlab
>> t = table(1, false, datetime(2023, 1, 1), VariableNames=["Number", "Logical", "Date"]);
>> rb = arrow.recordBatch(t)
rb =
Arrow RecordBatch with 1 row and 3 columns:
Schema:
Number: Float64 | Logical: Boolean | Date: Timestamp
First Row:
1 | false | 2023-01-01 00:00:00.000000
```
**Example Table Display**
```matlab
>> t = table(1, false, datetime(2023, 1, 1), VariableNames=["Number", "Logical", "Date"]);
>> arrowTable = arrow.table(t)
arrowTable =
Arrow Table with 1 row and 3 columns:
Schema:
Number: Float64 | Logical: Boolean | Date: Timestamp
First Row:
1 | false | 2023-01-01 00:00:00.000000
```
### Are these changes tested?
Yes, I added a new test class in `matlab/test/arrow/tabular` called `tTabularDisplay.m`.
### Are there any user-facing changes?
Yes. Users will now see the new `Table`/`RecordBatch` display
* Closes: apache#38166
Authored-by: Sarah Gilmore <[email protected]>
Signed-off-by: Kevin Gurney <[email protected]>
dgreiss
pushed a commit
to dgreiss/arrow
that referenced
this pull request
Feb 19, 2024
### Rationale for this change
Currently, the display for `arrow.tabular.RecordBatch` and `arrow.tabular.Table` are not very MATLAB-like.
### What changes are included in this PR?
1. Updated the display of both `arrow.tabular.Table` and `arrow.tabular.RecordBatch`.
2. Added a new utility function `arrow.internal.display.boldFontIfPossible`
3. Renamed `arrow.array.internal.display.pluralizeStringIfNeeded` to `arrow.internal.display.pluralizeStringIfNeeded`
4. Renamed `arrow.tabular.internal.displaySchema` to `arrow.tabular.internal.display.getSchemaString`.
**Example RecordBatch Display**
```matlab
>> t = table(1, false, datetime(2023, 1, 1), VariableNames=["Number", "Logical", "Date"]);
>> rb = arrow.recordBatch(t)
rb =
Arrow RecordBatch with 1 row and 3 columns:
Schema:
Number: Float64 | Logical: Boolean | Date: Timestamp
First Row:
1 | false | 2023-01-01 00:00:00.000000
```
**Example Table Display**
```matlab
>> t = table(1, false, datetime(2023, 1, 1), VariableNames=["Number", "Logical", "Date"]);
>> arrowTable = arrow.table(t)
arrowTable =
Arrow Table with 1 row and 3 columns:
Schema:
Number: Float64 | Logical: Boolean | Date: Timestamp
First Row:
1 | false | 2023-01-01 00:00:00.000000
```
### Are these changes tested?
Yes, I added a new test class in `matlab/test/arrow/tabular` called `tTabularDisplay.m`.
### Are there any user-facing changes?
Yes. Users will now see the new `Table`/`RecordBatch` display
* Closes: apache#38166
Authored-by: Sarah Gilmore <[email protected]>
Signed-off-by: Kevin Gurney <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale for this change
Currently, the display for
arrow.tabular.RecordBatchandarrow.tabular.Tableare not very MATLAB-like.What changes are included in this PR?
arrow.tabular.Tableandarrow.tabular.RecordBatch.arrow.internal.display.boldFontIfPossiblearrow.array.internal.display.pluralizeStringIfNeededtoarrow.internal.display.pluralizeStringIfNeededarrow.tabular.internal.displaySchematoarrow.tabular.internal.display.getSchemaString.Example RecordBatch Display
Example Table Display
Are these changes tested?
Yes, I added a new test class in
matlab/test/arrow/tabularcalledtTabularDisplay.m.Are there any user-facing changes?
Yes. Users will now see the new
Table/RecordBatchdisplay