Skip to content

Commit

Permalink
[doc] update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fangq committed Mar 28, 2024
1 parent 2e43586 commit 36b605d
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Contents.m
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,11 @@
% zlibencode - output = zlibencode(input)
% zstddecode - output = zstddecode(input)
% zstdencode - output = zstdencode(input)
% loadbidstsv - data = loadbidstsv(tsvfile)
% loadh5 - [data, meta] = loadh5(filename)
% loadjnifti - jnii=loadjnifti(inputfile)
% loadnifti - jnii=loadnifti(inputfile)
% nii2jnii - jnii=nii2jnii(niifile)
% niicodemap - newval=niicodemap(name, value)
% niiformat - niiheader=niiformat(format)
% niiheader2jnii - nii = niiheader2jnii(nii0)
14 changes: 14 additions & 0 deletions INDEX
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ Compression and Decompression
zstddecode
zstdencode
octavezmat
HDF5 file parser
loadh5
JNIfTI file parser
loadjnifti
loadnifti
nii2jnii
niicodemap
niiformat
niiheader2jnii
Helper Functions
decodevarname
encodevarname
Expand All @@ -59,3 +68,8 @@ Helper Functions
mergestruct
nestbracket2dim
varargin2struct
getvarfrom
regrouph5
transposemat
memmapstream
loadbidstsv
12 changes: 12 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ new features include
7. ``savejson/loadjson`` can use MATLAB/Octave built-in ``jsonencode/jsondecode`` using the ``BuiltinJSON`` option
8. automatically switch from ``struct`` to ``containers.Map`` when encoded key-length exceeds 63
9. provide fall-back zlib/gzip compression/decompression function (``octavezmat``) on Octave when ZMat is not installed
10. include built-in ``.nii/.nii.gz/.jnii/.h5/.snirf/.tsv/.csv`` parsers to allow loadjd.m to read wide range of files

There have been many major updates added to this release since the previous
release v2.0 in June 2020. A list of the major changes are summarized below
Expand All @@ -68,6 +69,17 @@ new interface functions ``savejd/loadjd``, and options to use MATLAB/Octave buil
included in the official distributions of Debian Bullseye and Ubuntu 21.04 or newer.


- 2024-03-27*[2e43586] [feat] merge ``nii/jnii/hdf5/tsv`` reading functions self-contained
- 2024-03-27 [b482c8f] [test] pass all tests on matlab R2010b
- 2024-03-27 [2008934] [doc] additional documentations on decompression functions
- 2024-03-27 [0a582fb] [doc] add documentations for jsonpath, jsoncache, jdlink, and maxlinklevel
- 2024-03-27 [5dba1de] [bug] ``..`` searches deep level of struct, make jdlink work for Octave 4.2 and 5.2
- 2024-03-27 [fea481e] [doc] add line-by-line comment on examples, add ``jsonset/jsonget``
- 2024-03-26 [e1d386d] [feat] support saving dictionary to json and bjdata
- 2024-03-26 [dfc744b] [feat] support caching data from any URL using hash, add ``NO_ZMAT`` flag
- 2024-03-24 [22d297e] [doc] fix README.rst formatting issues
- 2024-03-24 [7e27db5] [doc] update documentation, preparing for v2.9.8 release
- 2024-03-24 [1227a0b] [format] reformat
- 2024-03-24 [67f30ca] [feat] support using \. or [] in JSONPath to escape dots in key names
- 2024-03-24 [ee830cd] [bug] fix error_pos error when giving a non-existant input file
- 2024-03-24 [d69686d] [feat] add jdlink to dynamically download and cache linked data
Expand Down
12 changes: 12 additions & 0 deletions jsonlab.prj
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,18 @@ Please note that data files produced by `saveubjson` may utilize a special "opti
<file>${PROJECT_ROOT}/zlibencode.m</file>
<file>${PROJECT_ROOT}/zstddecode.m</file>
<file>${PROJECT_ROOT}/zstdencode.m</file>
<file>${PROJECT_ROOT}/getvarfrom.m</file>
<file>${PROJECT_ROOT}/loadbidstsv.m</file>
<file>${PROJECT_ROOT}/loadh5.m</file>
<file>${PROJECT_ROOT}/loadjnifti.m</file>
<file>${PROJECT_ROOT}/loadnifti.m</file>
<file>${PROJECT_ROOT}/memmapstream.m</file>
<file>${PROJECT_ROOT}/nii2jnii.m</file>
<file>${PROJECT_ROOT}/niicodemap.m</file>
<file>${PROJECT_ROOT}/niiformat.m</file>
<file>${PROJECT_ROOT}/niiheader2jnii.m</file>
<file>${PROJECT_ROOT}/regrouph5.m</file>
<file>${PROJECT_ROOT}/transposemat.m</file>
</fileset.rootfiles>
<fileset.depfun.included />
<fileset.depfun.excluded />
Expand Down

0 comments on commit 36b605d

Please sign in to comment.