inspec/docs/resources/cran.md.erb

---
title: About the cran Resource
---

# cran

Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.

<br> 

## Syntax

A `cran` resource block declares a package and (optionally) a package version:

    describe cran('package_name') do
      it { should be_installed }
    end

where

* `'package_name'` is the name of the package, such as `'DBI'`
* `be_installed` tests to see if the package described above is installed

<br>

## Resource Parameter Examples

The following examples show how to use this InSpec audit resource.

### Test if DBI is installed on the system

    describe cran('DBI') do
      it { should be_installed }
    end

### Test if DBI 0.5.1 is installed on the system

    describe cran('DBI') do
      it { should be_installed }
      its('version') { should eq '0.5.1' }
    end

<br>

## Property Examples

### version

The `version` property tests if the named package version is on the system:

    its('version') { should eq '1.2.3' }

<br>

## Matchers

This InSpec audit resource has the following matchers:

### be_installed

The `be_installed` matcher tests if the named package is installed on the system:

    it { should be_installed }