Improve show method of VecColumnTable with PrettyTables (#25)

Author: junyuan-chen

.github/workflows/CI-latest.yml

@@ -40,4 +40,6 @@ jobs:
             ${{ runner.os }}-test-
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
+      - name: Install latest dependencies
+        run: julia --project=. -e "using Pkg; Pkg.add(PackageSpec(name=\""DataFrames\"", rev=\""main\"")); Pkg.instantiate()"
       - uses: julia-actions/julia-runtest@v1

.github/workflows/CI-stable.yml

@@ -42,6 +42,8 @@ jobs:
             ${{ runner.os }}-test-
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
+      - name: Install latest dependencies
+        run: julia --project=. -e "using Pkg; Pkg.add(PackageSpec(name=\""DataFrames\"", rev=\""main\"")); Pkg.instantiate()"
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v1

Project.toml

@@ -13,6 +13,7 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 Missings = "e1d29d7a-bbdc-5cf2-9ac0-f12de2c33e28"
 PooledArrays = "2dfb63ee-cc39-5dd5-95bd-886bf059d720"
+PrettyTables = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 StatsFuns = "4c63d2b9-4356-54db-8cca-17b64c39e42c"
@@ -28,6 +29,7 @@ DataFrames = "0.22"
 MacroTools = "0.5"
 Missings = "0.4"
 PooledArrays = "1.2"
+PrettyTables = "0.12"
 Reexport = "0.2, 1"
 StatsBase = "0.33"
 StatsFuns = "0.9"

src/DiffinDiffsBase.jl

@@ -11,6 +11,7 @@ using LinearAlgebra: Diagonal
 using MacroTools: @capture, isexpr, postwalk
 using Missings: allowmissing, disallowmissing
 using PooledArrays: _label
+using PrettyTables: pretty_table
 using Reexport
 using StatsBase: CoefTable, Weights, stderror, uweights
 using StatsFuns: tdistccdf, tdistinvcdf

src/tables.jl

@@ -117,11 +117,12 @@ Base.show(io::IO, cols::VecColumnTable) = print(io, nrow(cols), '×', ncol(cols)
 
 function Base.show(io::IO, ::MIME"text/plain", cols::VecColumnTable)
     show(io, cols)
-    if ncol(cols) > 0
-        print(io, ":\n")
-        names = _names(cols)
-        types = map(c->eltype(c), _columns(cols))
-        Base.print_matrix(io, hcat(names, types))
+    if ncol(cols) > 0 && nrow(cols) > 0
+        println(io, ':')
+        pretty_table(IOContext(io, :limit=>true, :displaysize=>(15, 80)),
+            cols, vlines=1:1, hlines=1:1,
+            show_row_number=true, show_omitted_cell_summary=false,
+            newline_at_end=false, vcrop_mode=:middle)
     end
 end
 

test/tables.jl

@@ -18,6 +18,7 @@
     @test size(cols) == (0, 1)
     @test length(cols) == 1
     @test isempty(cols)
+    @test sprint(show, MIME("text/plain"), cols) == "0×1 VecColumnTable"
 
     cols = VecColumnTable((wave=hrs.wave,))
     @test size(cols) == (3280, 1)
@@ -74,11 +75,22 @@
     @test cols == deepcopy(cols)
 
     @test sprint(show, cols) == "3280×2 VecColumnTable"
-    w = VERSION < v"1.6.0" ? "  " : ""
     @test sprint(show, MIME("text/plain"), cols) == """
         3280×2 VecColumnTable:
-         :wave       Int64$w
-         :oop_spend  Float64"""
+          Row │  wave  oop_spend
+              │ Int64    Float64
+        ──────┼──────────────────
+            1 │    10    6532.91
+            2 │     8    1326.93
+            3 │    11    1050.33
+            4 │     9    979.418
+            5 │     7    5498.68
+          ⋮   │   ⋮        ⋮
+         3276 │    11    3020.78
+         3277 │     8     2632.0
+         3278 │     9     657.34
+         3279 │    10    782.795
+         3280 │     7    4182.39"""
 
     @test summary(cols) == "3280×2 VecColumnTable"
     summary(stdout, cols)