Merge pull request #18 from mcmcgrath13/non_tabular

feat(non-tabular-data): return path instead of empty dataset
queryverse · Aug 2, 2019 · 2113fdf · 2113fdf
2 parents acef41c + 01b6ed0
commit 2113fdf
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -45,3 +45,16 @@ using VegaLite, VegaDatasets
 
 dataset("iris") |> @vlplot(:point, x=:sepalLength, y=:petalWidth)
 ````
+
+### Non-tabular datasets
+
+The following datasets are not tabular in nature. A `Path` to the file location is returned instead of the data.
+
+* earthquakes
+* graticule
+* londonBoroughs
+* londonTubeLines
+* miserables
+* sf_temps
+* us_10m
+* world_110m
diff --git a/src/VegaDatasets.jl b/src/VegaDatasets.jl
@@ -97,16 +97,16 @@ end
 
 function dataset(name::AbstractString)
     if in(name, ["earthquakes", "graticule", "londonBoroughs", "londonTubeLines", "miserables", "sf-temps", "us-10m", "world-110m"])
-        @warn "Dataset not tabular: data field set to nothing, see path field for data file"
+        @warn "Dataset not tabular: returned Path instead of dataset"
         json_filename = normpath(joinpath(@__DIR__,"..","data", "data", "$name.json"))
         csv_filename = normpath(joinpath(@__DIR__,"..","data","data", "$name.csv"))
         tsv_filename = normpath(joinpath(@__DIR__,"..","data","data", "$name.tsv"))
         if isfile(json_filename)
-            return VegaDataset(nothing, Path(joinpath(@__DIR__,"..","data", "data", json_filename)))
+            return Path(json_filename)
         elseif isfile(csv_filename)
-            return VegaDataset(nothing, Path(joinpath(@__DIR__,"..","data", "data", csv_filename)))
+            return Path(csv_filename)
         elseif isfile(tsv_filename)
-            return VegaDataset(nothing, Path(joinpath(@__DIR__,"..","data", "data", tsv_filename)))
+            return Path(tsv_filename)
         end
     elseif isfile(joinpath(@__DIR__,"..","data", "data", name))
         if splitext(name)[2]==".csv" || splitext(name)[2]==".tsv"

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,5 +1,5 @@
 using VegaDatasets
-import IteratorInterfaceExtensions, TableTraits, TableShowUtils
+import IteratorInterfaceExtensions, TableTraits, TableShowUtils, FilePaths
 using Test
 
 @testset "VegaDatasets" begin
@@ -61,14 +61,14 @@ miserables = dataset("miserables")
 sf_temps = dataset("sf-temps")
 us_10m = dataset("us-10m")
 world_110m = dataset("world-110m")
-@test sprint(show, earthquakes) == ""
-@test sprint(show, graticule) == ""
-@test sprint(show, londonBoroughs) == ""
-@test sprint(show, londonTubeLines) == ""
-@test sprint(show, miserables) == ""
-@test sprint(show, sf_temps) == ""
-@test sprint(show, us_10m) == ""
-@test sprint(show, world_110m) == ""
+@test typeof(earthquakes) <: FilePaths.AbstractPath
+@test typeof(graticule) <: FilePaths.AbstractPath
+@test typeof(londonBoroughs) <: FilePaths.AbstractPath
+@test typeof(londonTubeLines) <: FilePaths.AbstractPath
+@test typeof(miserables) <: FilePaths.AbstractPath
+@test typeof(sf_temps) <: FilePaths.AbstractPath
+@test typeof(us_10m) <: FilePaths.AbstractPath
+@test typeof(world_110m) <: FilePaths.AbstractPath
 
 end