Skip to contents

Get Brain Mask from Template (DEPRECATED)

Source: R/template_flow.R
get_template_brainmask.Rd

DEPRECATED: Please use get_template(variant = "mask", ...) instead.

Convenience function to retrieve a binary brain mask for a specified template.

Usage

get_template_brainmask(
  name = "MNI152NLin2009cAsym",
  resolution = 1,
  extension = ".nii.gz"
)

Arguments

name

Character string specifying template name. Default: "MNI152NLin2009cAsym"

resolution

Numeric resolution in mm. Default: 1

extension

Character string specifying file extension. Default: ".nii.gz"

Value

A NeuroVol object containing the binary brain mask

See also

The new get_template

Examples

# \donttest{
if (requireNamespace("templateflow", quietly = TRUE)) {
  tryCatch(result <- get_template_brainmask(), error = function(e) NULL)
}
#> Warning: The `name` argument of `get_template_brainmask()` is deprecated as of
#> neuroatlas 0.10.0.
#> ℹ Please use `get_template()` instead.
#> [templateflow] Downloading https://templateflow.s3.amazonaws.com/tpl-MNI152NLin2009cAsym/tpl-MNI152NLin2009cAsym_res-01_desc-brain_mask.nii.gz
#> 
  |                                                                            
  |                                                                      |   0%
  |                                                                            
  |=======                                                               |  11%
  |                                                                            
  |=======================                                               |  34%
  |                                                                            
  |===============================                                       |  44%
  |                                                                            
  |=======================================                               |  55%
  |                                                                            
  |==============================================================        |  88%
  |                                                                            
  |===================================================================== |  98%
  |                                                                            
  |======================================================================| 100%
# }