-
Notifications
You must be signed in to change notification settings - Fork 373
Add documentation for JLD2 I/O #3365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alex-s-gardner
wants to merge
7
commits into
JuliaData:main
Choose a base branch
from
alex-s-gardner:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
844235e
Add documentation for JLD2 I/O
alex-s-gardner 8f32a2f
add JLD2.jl
alex-s-gardner f5ef5d3
missing "D" in "Dict"
alex-s-gardner aff1770
small text changes
alex-s-gardner 67ec270
move CSV above JLD2
alex-s-gardner 8b1bcba
improved description of jld2 read/write
alex-s-gardner 09735db
Merge branch 'main' into main
bkamins File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -113,6 +113,28 @@ As you can see the code required to transform `iris` into a proper input to the | |||
| format is not easy. Therefore CSV.jl is the preferred package to write CSV files | ||||
| for data stored in data frames. | ||||
|
|
||||
| ## JLD2 Files | ||||
|
|
||||
| A convenient format for reading and writing data frames in JLD2, which saves and loads | ||||
| Julia data structures in a format comprising a subset of HDF5. Unlike several other | ||||
| formats, JLD2 preserves custom Types. The `save` and `load` functions, provided by FileIO.jl, | ||||
| allow to read/write a data frame from/to a JLD2 file. | ||||
|
|
||||
| A data frame can be saved as a JLD2 file output.jld2 using | ||||
|
|
||||
|
Comment on lines
+123
to
+124
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||
| ```julia | ||||
| using FileIO | ||||
alex-s-gardner marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| using Pkg; Pkg.add("JLD2") | ||||
|
|
||||
| df = DataFrame(x=1, y=2) | ||||
| save("output.jld2", Dict("df" => df)) | ||||
| ``` | ||||
|
|
||||
| and can be read using | ||||
| ```julia | ||||
| load("output.jld2") # -> Dict{String, Any} with 1 entry: "df" => 1×2 DataFrame | ||||
alex-s-gardner marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| ``` | ||||
|
|
||||
| ## Other formats | ||||
|
|
||||
| Other data formats are supported for reading and writing in the following packages | ||||
|
|
||||
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.
Uh oh!
There was an error while loading. Please reload this page.