Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coatless-mac/r-macos-rtools

Scripts to build an **unofficial** Rtools-esq installer for the macOS R toolchain
https://github.com/coatless-mac/r-macos-rtools

bash gfortran llvm-clang macos osx package pkgbuild r xcode-cli

Last synced: 3 months ago
JSON representation

Scripts to build an **unofficial** Rtools-esq installer for the macOS R toolchain

Awesome Lists containing this project

README 

        
**This installer has been superceded by the [{macrtools}](https://github.com/coatless-mac/macrtools) _R_ package, which automatically installs and configures the _R_ toolchain for compiled code on macOS.**



**Please do not use the `r-macos-rtools` installer package as it is notably out of date.**



# Installer Package for macOS _R_ toolchain [![License](https://img.shields.io/badge/license-GPL%20%28%3E=%202%29-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-2.0.html)



The repository contains the scripts used to create an installer package (`.pkg`)

that contains binaries used to create the CRAN official macOS _R_ binary. 



Specifically, the installer will try to download and install:



- Xcode command line tools (XCode CLI) from Apple

- `gfortran6.3` or `gfortran8.2` from 



Moreover, the installer will attempt to clean up previous installations by 

removing configuration files `~/.R/Makevars` and `~/.Renviron` that are no longer used. 

Backups for each file will be presented with `.bck` appended to the end. 



For those interested, the installer can be obtained

on either the project's [**release page**](https://github.com/rmacoslib/r-macos-rtools/releases/latest).

The pre-built binaries this

installer encloses can be found at  and

. 



**Note** The installer package was developed by [James Joseph Balamuta](https://thecoatlessprofessor.com)

and has no connection with the R project’s macOS CRAN maintainers. 

Financial support was provided to sign the installer by 

[Professor Timothy Bates](http://www.ed.ac.uk/profile/timothy-bates) 

of the [University of Edinburgh](http://www.ed.ac.uk/).



## How do I use the installer?



1. Download it from the project's [**release page**](https://github.com/rmacoslib/r-macos-rtools/releases/latest).

2. Open the installer by either double click or right clicking to bring up menu and selecting "Open".

3. From here, navigate through it like a normal macOS installer.



**That's it.**



Once installed, you can start using compiled code in _R_ like normal.



If you want to see behind the curtain, continue reading...



## What does the installer do?



The macOS _R_ toolchain installer performs four actions that require

the user's password to accomplish. These actions are:



1. download and install XCode CLI via secure Apple product update

1. remove any existing `~/.R/Makevars` or `~/.Renviron` (backups available with `.bck`)s

1. determine which `gfortran` version to use

1. download, verify, and install the appropriate `gfortran` version



**Note:** The installer will remove any existing `~/.R/Makevars` and `~/.Renviron` files. 

The existing files will be copied to a backup file, e.g. `~/.R/Makevars.bck` and `~/.Renvion.bck`.



Verify steps are conducted using embedded md5 hashes of the files.

If the hash is not identical to what was embedded, the installer will

exit. For details as to how this was implemented please see

[Issue 8: Verify pkg hash](https://github.com/coatless/r-macos-rtools/issues/8)

and the 

[Pull Request 10: Feature Pkg Hash Verification](https://github.com/coatless/r-macos-rtools/pull/10).



## Verify the Installer



Thanks to the **financial support provided by [Professor Timothy Bates](http://www.ed.ac.uk/profile/timothy-bates) of

the [University of Edinburgh](http://www.ed.ac.uk/)** to join the [Apple Developer program](https://developer.apple.com/).

The installer is now signed using [developer credentials](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html).



As a result, the installer should have a "lock" icon in the upper right corner:



![Signed Installer Lock Icon](readme_img/lock_icon.png)



Clicking the lock icon will reveal the signed developer certificate:



![Signed Developer Certificate](readme_img/signed_certificate.png)



With this being said, the code used to generate the installer has been made publically available under an open source license (GPL >= 2). 



## Overview of Files



Below is an abridged version of the actions of each file provided.



- `scripts/postinstall`

   - Downloads and Installs Xcode CLI and the appropriate `gfortran` version

      - Detects the appropriate `Command Line Tools` dmg installer

	    by using a [headless cli check](https://github.com/timsutton/osx-vm-templates/blob/ce8df8a7468faa7c5312444ece1b977c1b2f77a4/scripts/xcode-cli-tools.sh#L8-L14),

		downloads the installer from ,

		and installs it using `softwareupdate`.

      - Downloads the gfortran binary  from 

        , and 

        and installs it into `/usr/local/gfortran`.

   - Removes the `~/.R/Makevars` and `~/.Renviron` files 

   - **Note:** Pre-existing `~/.R/Makevars` and `~/.Renviron` files will be backed up prior to being removed. 

- `make_installer.sh`

   - Create the installer package R binary installer `.pkg`

      - Builds the package from the extracted tar using `pkgbuild` 

      - Analyzing the package using `productbuild` to create a `distribution.xml`   

	  - Inserts customizations into the `distribution.xml` (title, background, ...)

	  - Calls `productbuild` to rebuild the package.

- `distribution.xml`

   - Customization options (e.g. title, background) of installer built by analyzing a temporary .pkg

- `build_files/Rlogo.png`

   - R logo

- `build_files/LICENSE.rtf`

   - License of the Xcode CLI, LLVM installer, and gfortran

- `build_files/WELCOME_DISPLAY.rtf`

   - Text displayed on welcome screen



# License



GPL (>= 2)