https://github.com/abbgrade/PSRTools

PowerShell Cmdlets that wrap RScript to support admin tasks
https://github.com/abbgrade/PSRTools

Last synced: 9 days ago
JSON representation

PowerShell Cmdlets that wrap RScript to support admin tasks

• Host: GitHub
• URL: https://github.com/abbgrade/PSRTools
• Owner: abbgrade
• License: mit
• Created: 2019-11-02T15:36:12.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-15T08:00:35.000Z (over 4 years ago)
• Last Synced: 2024-08-13T07:05:57.733Z (4 months ago)
• Language: PowerShell
• Size: 54.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - abbgrade/PSRTools - PowerShell Cmdlets that wrap RScript to support admin tasks (PowerShell)

README

        
# PSRTools

This PowerShell Modules helps to integrate R into DevOps processes for continuous integration and continuous deployment.

[![Build status](https://ci.appveyor.com/api/projects/status/wprgefs7vsaug8sv?svg=true)](https://ci.appveyor.com/project/abbgrade/psrtools)

## Installation

Install PSDocker from [PowerShell Gallery](https://www.powershellgallery.com/packages/psrtools) using a PowerShell command line:

    Install-Module -Name PSRTools -Scope CurrentUser

## Build

This project uses a [build script](./PSRTools.build.ps1) that is based on [Invoke-Build](https://github.com/nightroman/Invoke-Build).

For installation details see the instructions from the Invoke-Build project, but we recommend `Install-Module InvokeBuild -Scope CurrentUser`.

The documentation is based on [platyPS](https://github.com/PowerShell/platyPS), so you may want to execute `Install-Module PlatyPs -Scope CurrentUser`.

You can run the build by:

- __PowerShell__: execute `Invoke-Build` in a PowerShell in the directory of this project

- __VSCode__: run the integrated build task feature (F1 + "Tasks: Run Build Task")

## Test

This project uses test scripts using [Pester](https://github.com/pester/Pester).

For installation details see the instructions from the Pester project, but we recommend `Install-Module Pester -Scope CurrentUser`.

The tests depend on the default installation of Microsoft R Open and RTools, that can be installed by `choco install microsoft-r-open` and `choco install rtools`.

You can run the tests by:

- __PowerShell__: execute `Invoke-Build Test` in a PowerShell in the directory of this project

- __VSCode__: run the integrated test task feature (F1 + "Tasks: Run Test Task")

For debugging tests change the working directory to ./src/test create the breakpoint in VSCode and start debugging by F1 + "Debug: Start Debugging".

## Usage

See the folder [docs](./docs) for examples.

## Changelog

### Version 0.4.1

- Updated docs for Install-Package.

### Version 0.4.0

- Added Library parameter to existing cmdlets

- Added installation of local package archives

### Version 0.3.0

- New function New-RDocumentation

### Version 0.2.0

- New functions New-RPackage, Invoke-RCommand and Get-REscapedString

### Version 0.1.0

- New functions Install-RPackage, Get-RLibrary and Get-RVersion