Skip to content

Update instructions for R binary distribution. - #2616

Merged
zivy merged 1 commit into
SimpleITK:mainfrom
zivy:updateReadTheDocs
Jun 29, 2026
Merged

zivy merged 1 commit into
SimpleITK:mainfrom
zivy:updateReadTheDocs

Conversation

@zivy

@zivy zivy commented Jun 29, 2026

Copy link
Copy Markdown
Member

Update instructions to reflect the new distribution of R binaries via the r-universe SimpleITK.foyer package.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the “Getting Started” documentation to reflect that SimpleITK R binaries are now distributed (via an installer) rather than being unavailable, aligning the docs with the new r-universe-based distribution approach.

Changes:

  • Update the general “Downloading the binaries” platform-availability sentence to include R binaries.
  • Replace the “R binaries are not available” section with updated installation guidance and links.
  • Keep source-build fallback instructions for cases where a binary is unavailable.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/source/gettingStarted.rst Outdated
Linux and Mac OS X. **C# and Java** binaries are available for
Windows. **R** binaries are not available but a convenient
`remotes based installer <https://github.com/SimpleITK/SimpleITKRInstaller>`__ for Linux and Mac is.
Windows. **R** binaries are available for Windows, Linux and Mac (intel).

@zivy zivy Jun 29, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and force pushed.

Comment thread docs/source/gettingStarted.rst Outdated
Comment on lines +128 to +131
R binaries are available for Windows, Linux, and Mac (intel) and are distributed using a lightweight installer available via the r-universe. Detailed installation instructions are `available on GitHub <https://github.com/SimpleITK/SimpleITKRInstaller/tree/main/SimpleITK_Foyer>`__.

For Linux and Mac one can easily build and install SimpleITK from source using a `remotes <https://cran.r-project.org/web/packages/remotes/readme/README.html>`__ based installer
referencing this `GitHub Repository <https://github.com/SimpleITK/SimpleITKRInstaller>`__.
If the binary package you need is not available, you can build and install SimpleITK using a `remotes <https://cran.r-project.org/web/packages/remotes/readme/README.html>`__ based installer
following the instructions available in this `GitHub Repository <https://github.com/SimpleITK/SimpleITKRInstaller>`__.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to make these changes. The text here is a reference to the instructions that are maintained in one place, the foyer package on GitHub.

Update instructions to reflect the new distribution
of R binaries via the r-universe SimpleITK.foyer package.
@zivy
zivy force-pushed the updateReadTheDocs branch from 385705c to b02fba9 Compare June 29, 2026 18:30
@zivy
zivy merged commit a165723 into SimpleITK:main Jun 29, 2026
3 checks passed
@zivy
zivy deleted the updateReadTheDocs branch June 29, 2026 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants