An RPGM project is an application with R as back-end engine. Such a project is built with RCode and executed with RPGM. The link between both softwares is done with a
.pgm file. Once the RPGM project built, in the top menu, PGM -> Export as PGM creates a
.pgm file. This file can be imported and read by RPGM which executes the application.
The .pgm file is also used by the service RPGM Server and the service RPGM Standalone.
At any moment, an RPGM project can be tested on-the-fly in RCode with the top menu PGM -> Run in RPGM option or with its shortcut F5.
This section explains how to start an RPGM project and the general settings in the
Create an RPGM Project
An RPGM project, like an R project, corresponds to a folder. You can create a new project with the top menu File -> New project.... At the creation of the project, it adds two files:
project.pprowhich is the file with the general properties of the project, described hereafter.
main.pseqwhich is the sequence in witch the RPGM application starts, such a file is explained the the Sequence page.
You can already execute the application with F5, which is empty at this stage.
The project.ppro File
The project.ppro file is split into three tabs that are explained below.
The fields Name, Company and Description are described in the screenshot above. The other ones are:
- First sequence: the application starts by following a sequence, it is the sequence in which RPGM starts (default is
main.pseq, which is created with a new project).
- R working directory: for relative paths in R, it can be in the program's folder or in the output folder.
- Output folder name: the name of the output folder in the end user file system.
- Allow R and RData: three options:
Allow R and RData(by default, the end user in RPGM can download the R environment as an .RData file and access the R console),
Only allow to save RData(the end user can download the R environment but has no console access), and
None(the end-user cannot download the R session nor access to the R console).
- Top logo: an image displayed on the top right of the application, below the Name.
- Show steps list: shows or hides the right side bar of the application (which contains the Name, the Top logo if filled, and the list of the executed steps).
Contains information about the evolution of the application. Appears in the "View detail" of the application in RPGM.
You can modify the visual apparences of RPGM elements and create custom CSS classes which will be applied to widgets. Details can be found in
- CSS Tutorial which shows all use cases of the CSS throught a small project.
- API CSS References which gives the name of all internal RPGM classes / elements.
This CSS is called after all other CSS of the RPGM application.