Add documentation for JLD2 I/O by alex-s-gardner · Pull Request #3365 · JuliaData/DataFrames.jl

alex-s-gardner · 2023-07-29T02:49:02Z

Addresses #3364

docs/src/man/importing_and_exporting.md

bkamins · 2023-08-01T10:56:04Z

I have left some stylistic comments.

Additionally, since I am not using JLD2 format myself. The question is how does it handle saving SubDataFrame, or GroupedDataFrame (I assume that it saves them correctly by strong both the view object and the underlying DataFrame?).

alex-s-gardner · 2023-08-01T22:07:14Z

The question is how does it handle saving SubDataFrame, or GroupedDataFrame (I assume that it saves them correctly by strong both the view object and the underlying DataFrame?).

I tested saving and loading both SubDataFrame and GroupedDataFrame and they seem to work just fine... is this something that we should mention?

maybe here:

.... , JLD2 preserves custom Types including SubDataFrame and GroupedDataFrame.

bkamins · 2023-09-25T21:17:15Z

Sorry for a delay. I think it is OK the way you proposed. Just can you please move JLD2 after CSV (as CSV is for sure more popular).

Also @nalimilan - could you please have a look at wording of the PR?

docs/src/man/importing_and_exporting.md

nalimilan

Sorry for the delay!

nalimilan · 2023-10-14T15:21:07Z

docs/src/man/importing_and_exporting.md

+
+If you have not used the FileIO and JLD2 packages before then you may need to install it first:
+```julia
+using Pkg; 


Suggested change

using Pkg;

using Pkg

nalimilan · 2023-10-14T15:29:13Z

docs/src/man/importing_and_exporting.md

+A data frame can be saved as a JLD2 file output.jld2 using
+


Suggested change

A data frame can be saved as a JLD2 file output.jld2 using

nalimilan · 2023-10-14T15:30:06Z

docs/src/man/importing_and_exporting.md

+using JLD2
+```
+
+We can now create a simple data frame and save it as a jld2 file using `save`. `save` 


Suggested change

We can now create a simple data frame and save it as a jld2 file using `save`. `save`

We can now create a simple data frame and save it as a JLD2 file using `save`. `save`

nalimilan · 2023-10-14T15:30:49Z

docs/src/man/importing_and_exporting.md

+```
+
+We can now create a simple data frame and save it as a jld2 file using `save`. `save` 
+accepts an AbstractDict yielding the key/value pairs, where the key is a string representing 


Suggested change

accepts an AbstractDict yielding the key/value pairs, where the key is a string representing

accepts an `AbstractDict` yielding the key/value pairs, where the key is a string representing

nalimilan · 2023-10-14T15:33:15Z

docs/src/man/importing_and_exporting.md

+Pkg.add("FileIO")
+Pkg.add("JLD2")


This will typically be faster:

Suggested change

Pkg.add("FileIO")

Pkg.add("JLD2")

Pkg.add(["FileIO", "JLD2"])

nalimilan · 2023-10-14T15:38:16Z

docs/src/man/importing_and_exporting.md

+A jld2 file can be read in using `load`. If `load` is called with a single dataset name, 
+load returns the contents of that dataset from the file:
+```julia
+df = load("output.jld2", "df")


Suggested change

df = load("output.jld2", "df")

julia> df = load("output.jld2", "df")

nalimilan · 2023-10-14T15:38:34Z

docs/src/man/importing_and_exporting.md

+df = load("output.jld2")
+Dict{String, Any} with 1 entry:
+  "df" => 1×2 DataFrame…


Suggested change

df = load("output.jld2")

Dict{String, Any} with 1 entry:

"df" => 1×2 DataFrame…

julia> dict = load("output.jld2")

Dict{String, Any} with 1 entry:

"df" => 1×2 DataFrame…

julia> df = dict.df

1×2 DataFrame

Row │ x y

│ Int64 Int64

─────┼──────────────

1 │ 1 2

nalimilan · 2023-10-14T15:39:29Z

docs/src/man/importing_and_exporting.md

+JLD2 is a HDF5-compatible file format that allows reading and writing data frames.
+A valuable feature of JLD2 format is that it preserves custom column types of the stored data frame.
+
+The `save` and `load` functions, provided by FileIO.jl, allow to read/write a data frame from/to a JLD2 file.  


Suggested change

The `save` and `load` functions, provided by FileIO.jl, allow to read/write a data frame from/to a JLD2 file.

The `save` and `load` functions, provided by [FileIO.jl](https://github.com/JuliaIO/FileIO.jl/),

provides convenience functions to read/write objects from/to a JLD2 file.

nalimilan · 2023-10-14T15:39:50Z

docs/src/man/importing_and_exporting.md

+## JLD2 Files
+
+JLD2 is a HDF5-compatible file format that allows reading and writing data frames.
+A valuable feature of JLD2 format is that it preserves custom column types of the stored data frame.


Suggested change

A valuable feature of JLD2 format is that it preserves custom column types of the stored data frame.

A valuable feature of the JLD2 format is that it preserves custom column types of the stored data frame.

nalimilan · 2023-10-14T15:40:16Z

docs/src/man/importing_and_exporting.md


+## JLD2 Files
+
+JLD2 is a HDF5-compatible file format that allows reading and writing data frames.


Suggested change

JLD2 is a HDF5-compatible file format that allows reading and writing data frames.

[JLD2](https://github.com/JuliaIO/JLD2.jl) is a HDF5-compatible file format that allows

reading and writing data frames (and any Julia object).

Add documentation for JLD2 I/O

844235e

bkamins reviewed Jul 29, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Outdated Show resolved Hide resolved

bkamins added the doc label Jul 29, 2023

bkamins added this to the 1.7 milestone Jul 29, 2023

alex-s-gardner added 2 commits July 31, 2023 13:34

add JLD2.jl

8f32a2f

missing "D" in "Dict"

f5ef5d3

bkamins reviewed Aug 1, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Outdated Show resolved Hide resolved

bkamins reviewed Aug 1, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Outdated Show resolved Hide resolved

bkamins reviewed Aug 1, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Outdated Show resolved Hide resolved

small text changes

aff1770

bkamins requested a review from nalimilan September 25, 2023 21:17

move CSV above JLD2

67ec270

bkamins reviewed Sep 27, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Outdated Show resolved Hide resolved

bkamins reviewed Sep 27, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Show resolved Hide resolved

bkamins reviewed Sep 27, 2023

View reviewed changes

docs/src/man/importing_and_exporting.md Outdated Show resolved Hide resolved

alex-s-gardner and others added 2 commits September 27, 2023 10:51

improved description of jld2 read/write

8b1bcba

Merge branch 'main' into main

09735db

nalimilan reviewed Oct 14, 2023

View reviewed changes

bkamins modified the milestones: 1.7, 1.x Sep 14, 2024

	We can now create a simple data frame and save it as a jld2 file using `save`. `save`
	We can now create a simple data frame and save it as a JLD2 file using `save`. `save`

	accepts an AbstractDict yielding the key/value pairs, where the key is a string representing
	accepts an `AbstractDict` yielding the key/value pairs, where the key is a string representing

	df = load("output.jld2", "df")
	julia> df = load("output.jld2", "df")

	The `save` and `load` functions, provided by FileIO.jl, allow to read/write a data frame from/to a JLD2 file.
	The `save` and `load` functions, provided by [FileIO.jl](https://github.com/JuliaIO/FileIO.jl/),
	provides convenience functions to read/write objects from/to a JLD2 file.

	A valuable feature of JLD2 format is that it preserves custom column types of the stored data frame.
	A valuable feature of the JLD2 format is that it preserves custom column types of the stored data frame.


		## JLD2 Files

		JLD2 is a HDF5-compatible file format that allows reading and writing data frames.

	JLD2 is a HDF5-compatible file format that allows reading and writing data frames.
	[JLD2](https://github.com/JuliaIO/JLD2.jl) is a HDF5-compatible file format that allows
	reading and writing data frames (and any Julia object).

Conversation

alex-s-gardner commented Jul 29, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bkamins commented Aug 1, 2023

Uh oh!

alex-s-gardner commented Aug 1, 2023

Uh oh!

bkamins commented Sep 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nalimilan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants