_pkgdown.yml_bak.yml

template:
  params:
    bootswatch: flatly


reference:
  - title: read and write brain images
    desc: >
      read and write 3D or 4D NIFTI neuroimaging files into R
    contents:
    - read_vol
    - write_vol
    - read_vec
    - write_vec
    - read_header

  - title: create image data structures
    desc: >
      constructor function for 2D, 3D, and 4D imaging data structures.
    contents:
    - NeuroSlice
    - NeuroVol
    - SparseNeuroVol
    - ClusteredNeuroVol
    - SparseNeuroVec
    - NeuroVecSeq
    - MappedNeuroVec
    - FileBackedNeuroVec
    - ROIVol
    - ROIVec

  - title: get information about data structures
    desc: >
      Functions to access information about the shape, size, and structure of images
    contents:
    - space
    - ndim
    - spacing
    - which_dim
    - dim_of
    - axes
    - bounds
    - origin
    - trans
    - voxels
    - centroid
    - centroids

  - title: querying, dividing, slicing, and extracting data from image data structures
    desc: >
      Functions to extract portions of data or split up data into sub-regions for further processing
    contents:
    - vols
    - vectors
    - split_clusters
    - split_blocks
    - patch_set
    - slices
    - series
    - series_roi
    - partition
    - sub_vector

  - title: searchlight functions
    desc: >
      Functions to support "searchlight" analyses of image data
    contents:
    - searchlight
    - searchlight_coords
    - clustered_searchlight
    - random_searchlight
    - bootstrap_searchlight