Package 'SimpleITK.foyer'

Title: Lightweight Installer for SimpleITK
Description: Provides a lightweight installer for the SimpleITK package, which is an interface to the Insight Toolkit (ITK) for medical image segmentation and registration. After installing this package, call install_simpleitk(). to download and install the pre-built binary packages for your platform from the SimpleITKRInstaller GitHub releases. Due to the large size of the compiled package, the actual functionality is distributed as platform-specific binaries on GitHub.
Authors: Richard Beare [aut], Bradley Lowekamp [aut], Ziv Yaniv [aut, cre]
Maintainer: Ziv Yaniv <[email protected]>
License: Apache License (>= 2)
Version: 1.0.0
Built: 2026-06-23 13:15:57 UTC
Source: https://github.com/SimpleITK/SimpleITKRInstaller

Help Index

Install SimpleITK Binary Package

Description

Downloads and installs the pre-built SimpleITK binary package for your platform and R version from GitHub releases.

Usage

install_simpleitk(
  version = NULL,
  lib = .libPaths()[1],
  repos = NULL,
  force = FALSE,
  quiet = FALSE
)

Arguments

version

Character string specifying the SimpleITK version to install. Defaults to the version of this foyer package.
lib

Character string specifying the library path where the package should be installed. Defaults to the first element of .libPaths().
repos

Character string specifying alternative repository URL. By default, uses GitHub releases.
force

Logical. If TRUE, forces reinstallation even if the package is already installed.
quiet

Logical. If TRUE, suppresses progress messages.

Details

This function detects your operating system, R version, and architecture, then downloads the appropriate pre-built binary package from the SimpleITK GitHub releases. The binary packages are built by the SimpleITK project and hosted at: https://github.com/SimpleITK/SimpleITKRInstaller/releases

Supported platforms:

  • Windows x86_64 (R >= 4.0)

  • macOS x86_64 (R >= 4.0)

  • macOS ARM64 (R >= 4.0)

  • Linux x86_64 (R >= 4.0)

Value

Invisibly returns TRUE if installation succeeds, FALSE otherwise.

Examples

## Not run: 
# Install SimpleITK for your platform
install_simpleitk()

# Install a specific version
install_simpleitk(version = "2.5.0")

# Force reinstallation
install_simpleitk(force = TRUE)

## End(Not run)

SimpleITK Version Information (Stub)

Description

This is a stub function that will be replaced by the actual function once the full SimpleITK package is installed via install_simpleitk().

Usage

Version()

Value

NULL if SimpleITK is not installed, otherwise calls the real Version function