Skip to content

Improve documentation.#88

Merged
zivy merged 1 commit intoSimpleITK:mainfrom
zivy:improveDocumentation
Apr 14, 2026
Merged

Improve documentation.#88
zivy merged 1 commit intoSimpleITK:mainfrom
zivy:improveDocumentation

Conversation

@zivy
Copy link
Copy Markdown
Member

@zivy zivy commented Apr 14, 2026

Add details so that users only use the default
configuration in resource constrained settings and use multi-core compiliation. Also, highlight the
need to match the targeted R version and rtools
versions.

Add details so that users only use the default
configuration in resource constrained settings and
use multi-core compiliation. Also, highlight the
need to match the targeted R version and rtools
versions.
@zivy zivy requested a review from blowekamp April 14, 2026 14:30
Comment thread README.md
On Windows requires [rtools](https://cran.r-project.org/bin/windows/Rtools/) installation and setting the `RTOOLS_HOME` environment variable. For example:
On Windows requires [rtools](https://cran.r-project.org/bin/windows/Rtools/) installation and setting the `RTOOLS_HOME` environment variable. Install the rtools version that matches the targeted R version. For example, using the R4.5.3 and rtools4.5 combination, set the enviornment variable to:
```R
Sys.setenv(RTOOLS_HOME = "C:/rtools45")
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I am not sure this is correct or necessary. When the R package is built certain env variable are set, we are using these a little but and could do better to use them in the scripts.

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.

Setting the RTOOLS_HOME is required as it changes per the rtools version (enabling multiple rtools version on same machine). The matching with the R major.minor version is required per the rtools documentation.

@blowekamp blowekamp self-requested a review April 14, 2026 17:29
@zivy zivy merged commit 7e59ea5 into SimpleITK:main Apr 14, 2026
7 checks passed
@zivy zivy deleted the improveDocumentation branch April 14, 2026 18:08
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.

2 participants