From 3d09e5ef7072e0859261e79f2ba5bd45299b1bdd Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Tue, 10 Oct 2023 06:24:03 +0000 Subject: [PATCH] build based on 31902c4 --- dev/.documenter-siteinfo.json | 2 +- dev/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 0405253..ebe6ce0 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-09T20:49:07","documenter_version":"1.1.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-10T06:23:59","documenter_version":"1.1.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index c8502df..91cdc98 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,3 +1,3 @@ Home · DataViewer.jl

DataViewer

Documentation for DataViewer.

DataViewer.filetype — Method
filetype(v::Val)

Get the file type associated to the name extension given by v = Val(Symbol(extension)).

Example

julia> filetype(Val(Symbol(".jld2")))
-JLD2File
source
DataViewer.get_data — Function
get_data(container, path)

Get the piece of data stored in container under path.

get_data(container, (a, b, b))

should be more or less equivalent to

container[a][b][c]
source
DataViewer.graphic_repr — Method
(options, repr) = graphic_repr(x)

If x supports one or more graphical representation(s), options is a non-empty Vector{RepresentationOption}. In that case, calling repr(options[i].param) should produce the graphical representation corresponding to the i-th entry in the list.

source
DataViewer.open_datafile — Function
open_datafile(fun, fname, ftype)

Load the data contained in fname, which should be stored using the format described by ftype. Apply fun on the loaded data. This function guarantees that the file stays open as long as needed, but is closed before the function returns.

Example

``` julia> ftype = filetype(Val(Symbol(".jld2"))) JLD2File

julia> open_datafile("sample.jld2", ftype) do data println(typeof(data)) end Dict

source
DataViewer.pretty_repr — Method
pretty_repr(x) -> String

Return a pretty textual representation of x. By default it is based on show, but can be customized as needed.

source
DataViewer.recurse_into — Method
recurse_into(x) -> Bool

Tells whether x is some form of "container" that can be recursed into, or a "leaf" data.

source
DataViewer.view — Function
view(fname::String, ftype = "")

Open a viewer window for the data contained in file fname. The extension of fname is used to determine how to read it.

Because the file may need to be accessed during the whole browsing session, this function does not return until the window has been closed, at which point the data file itself is closed as well.

source
DataViewer.view — Function
view(data, name = "")

Open a viewer window for data, which may be a dictionary, HDF5 file, or possibly another key=>value based data type.

Optionally, name is a String indicating where data originates from (for example, a file name).

source
+JLD2Filesource
DataViewer.get_data — Function
get_data(container, path)

Get the piece of data stored in container under path.

get_data(container, (a, b, b))

should be more or less equivalent to

container[a][b][c]
source
DataViewer.graphic_repr — Method
(options, repr) = graphic_repr(x)

If x supports one or more graphical representation(s), options is a non-empty Vector{RepresentationOption}. In that case, calling repr(options[i].param) should produce the graphical representation corresponding to the i-th entry in the list.

source
DataViewer.open_datafile — Function
open_datafile(fun, fname, ftype)

Load the data contained in fname, which should be stored using the format described by ftype. Apply fun on the loaded data. This function guarantees that the file stays open as long as needed, but is closed before the function returns.

Example

``` julia> ftype = filetype(Val(Symbol(".jld2"))) JLD2File

julia> open_datafile("sample.jld2", ftype) do data println(typeof(data)) end Dict

source
DataViewer.pretty_repr — Method
pretty_repr(x) -> String

Return a pretty textual representation of x. By default it is based on show, but can be customized as needed.

source
DataViewer.recurse_into — Method
recurse_into(x) -> Bool

Tells whether x is some form of "container" that can be recursed into, or a "leaf" data.

source
DataViewer.view — Function
view(fname::String, ftype = "")

Open a viewer window for the data contained in file fname. The extension of fname is used to determine how to read it.

Because the file may need to be accessed during the whole browsing session, this function does not return until the window has been closed, at which point the data file itself is closed as well.

source
DataViewer.view — Function
view(data, name = "")

Open a viewer window for data, which may be a dictionary, HDF5 file, or possibly another key=>value based data type.

Optionally, name is a String indicating where data originates from (for example, a file name).

source