Releases: dfsp-spirit/fsbrain
Releases · dfsp-spirit/fsbrain
v0.5.5 - Minor update for new CRAN checks
Version 0.5.5
- Change some minor docstring issues in internal functions (requested by CRAN team)
v0.5.4 -- Add support for latest rgl version and r-base 4.3
v0.5.4 -- Add support for latest rgl version and r-base 4.3
- FIX: Change usage of rgl functions that were recently deprectated to current API. This ensures that fsbrain is compatible with the latest rgl version. Thanks to @dmurdoch for the patch. Fixes #52.
- Add 'delete_colorbar_img' parameter to 'combine.colorbar.with.brainview.image()' function. This is TRUE by default, meaning that the merged cbar image file (fsbrain_cbar.png by default) will be deleted after the merge operation by default. This changes the old behaviour, in which the file was left behind in the current working directory.
- Rename some internal functions and fix various small complaints from the latest version of R CMD CHECK, from r-base 4.3. (Required for CRAN upload.)
- NEW: Support plotting colorbar with log scale, implements feature request #44
- FIX: Fix broken hemis on 9 view with inflated surfaces, see issue #50
Legend support for volume visualizations
Version 0.5.3
- Add vis.seg.legend() function to visualize legend for a segmented volume based on color lookup table.
- Replace all 'donttest' instructions in examples with 'dontrun', because CRAN runs the 'donttest' stuff and fails on it.
Borders when drawing region based data, more geodesic functions
Version 0.5.1
- Add clip_fun as an alternative to clip.data for rglactions. This makes the API more consistent, see limit_fun.
- More links between function documentation, especially to rglactions. Makes it easier to find navigate the docs.
- Tests: explicitely use testthat namespace in more tests for easier copy and pasting of test code.
- Add some functions for working with FreeSurfer longitudinal preprocessing pipelines and QDEC tables.
- Expose geodesic functions as part of public API.
- Data loading: support aggregating atlas over hemis separately.
- Support drawing region borders with function vis.region.values on.subject
- Docs: more links between docs for easier navigation in help browser, fix various typos.
- Deps: use freesurferformats 0.1.16
v0.5.0: Fast mesh ops with Rvcg and many fixes
Version 0.5.0
- Breaking change: remove long deprecated parameter 'colormap' from all vis functions. Use the 'makecmap_options' parameter instead.
- The function vis.color.on.subject now supports the 'style' parameter supported by other vis functions.
- Add new highlight.* functions which are useful mainly for debugging.
- Fix accidental printing of rglactions to console when calling vis functions.
- Add new 'export' function, an alias for 'vis.export.from.coloredmeshes' so you have to type less. Updated vignettes and example notebooks accordingly.
- Add new entry on vector graphics conversion to the 'fsbrain FAQ' vignette.
- Add surface.curvatures function that can compute k1 and k2 (requires optional dependency package 'Rvcg').
- Add functions to write group standard space per-vertex data: write.group.morph.standard and write.group.morph.standard.mf
- Add new and more convenient volume visualization function: volvis.lb is a convenient wrapper around volvis.lightbox.
- Add new function demographics.to.qdec.table.dat that can convert a demographics dataframe from an Excel or CSV file to qdec.table.dat format and write the additional factor level files.
- Add new sjd.demo() function, a shortcut to download optional demonstration data and get the path to the downloaded subjects dir.
- Add vis.subject.pre function, a new high-level function for visualizing preloaded data (see #31)
Convenience features and transparent background
Version 0.4.3
- Add support for exporting figures with transparent background in
vis.export.from.coloredmeshes
function, see parameter 'transparency_color' and docs. A usage example is in the fsbrain FAQ vignette. - Change default value for the NA-color in 'mkco.*' functions from white (#FFFFFF) to very light gray (#FEFEFE).
- Support custom background color in various visualization functions, including
vis.export.from.coloredmeshes
. See the docs for the new parameter 'background_color'. - One can now suppress rendering of a colorbar with the
vis.export.from.coloredmeshes
function by passing 'NULL' for the colorbar orientation parameter 'horizontal'. - Add new R live notebook that illustrates how to use the Export API to produce publication-ready plots. It is linked on the GitHub page, see the Documentation section.
- Disable all unit tests that require extra data on CRAN, downloading them is not possible anymore. We still test on Travis CI and Appveyor CI so that should not make much of a difference.
- Add new 'highlight.vertices.on.subject' function, it does what the name says. Very handy for debugging stuff like coordinate transformations and illustrating things in presentations and bug reports.
Some fixes related to plotting with fixed data range
Experimental DTI track visualization support
This release was needed for technical reasons related to CRAN. Most important changes:
- Support for visualizing TRK and TCK files (Fiber track files from Diffusion Tensor Imaging) created in Diffusion Toolkit and MRtrix3
- Delete all unit test data after tests have been run if on CRAN
The DTI visualization support is still a bit experimental, and the visualization style may change in the future.
The paper release
- Support passing a single data vector for both hemis combined to vis.data.on.subject and vis.symmetric.data.on.subject
- Add subject.num.verts function to easily retrieve the vertex counts of the meshes for a subject
- Support new background color layers 'curv_light' and 'sulc_light'
- The function vis.symmetric.data.on.subject defaults to a new colormap.
- The metadata IO function to read subjects files and demographics files no longer have a default for the 'header' parameter. This is to prevent people from accidently skipping the first subject.
- Add functions for reading and writing morph data to and from a single MGH or MGZ file: group.morph.standard.sf and write.group.morph.standard.sf
- Add function for writing FSGD files from demographics table (demographics.to.fsgd.file), and to read subjects list from FSGD files (read.md.subjects.from.fsgd)
- new method to set default resolution, and more consistent usage of defaults: fsbrain.set.default.figsize()
- Add group.surface function to load surfaces for a group of subjects
- Add functions for visualization of groups of subjects at once: vis.group.morph.native, vis.group.morph.standard, vis.group.annot, ...
- Extend advanced live notebook with group level plotting examples
- Better support for limiting the plotted data range
- Add new rendering style 'edges', expose style argument for more vis functions
- Fix bug in coloredmesh.from.morph.standard: custom template subject was ignored
- Add option to download a few files from fsaverage3 under FreeSurfer license. User needs to accept license.
Cleanups and fixes
Version 0.3.0
- Fix reading standard space data from template subjects other than fsaverage
- Add new cbry colormap and related mkco.cluster function, great for visualizing clusters
- Support pushing hemispheres apart to prevent overlapping inflated surfaces, fixes #7
- Remove rotate2D, flip2D, and readable.files functions, they have been moved to the freesurferformats package
- requires freesurferformats version >= 0.1.11 (up from 0.1.10)
- default to using rglot() as rgloptions parameter (instead of empty list) for vis functions, i.e., increase default plot resolution