Skip Headers
Oracle® R Enterprise Installation and Administration Guide
Release 1.3.1 for Windows, Linux, Solaris, and AIX

E36763-17
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

5 Installing Oracle R Enterprise Client

This chapter explains how to install Oracle R Enterprise Client. This chapter includes these topics:

5.1 About Oracle R Enterprise Client

This topic includes the following:

5.1.1 Client Components of Oracle R Enterprise

Oracle R Enterprise includes several components that must be installed separately on each client computer. The Oracle R Enterprise client components, listed below, can be installed in any order:

  • R (See Chapter 3, "Installing R")

  • Oracle Database Client Software

  • Oracle R Enterprise client packages

  • Oracle R Enterprise client supporting packages

An illustration of the client and server components of Oracle R Enterprise is shown in Figure 1-2.

5.1.2 About Oracle Database Client Software

ROracle, one of the client supporting packages used by Oracle R Enterprise, requires an installation of Oracle Database client software to enable communication between an R client and an Oracle database. The Database client can be either Oracle Database Client or Oracle Database Instant Client:

  • Oracle Database Client is distributed with Oracle Database and is based in the Oracle Home of the database.

  • Oracle Database Instant Client is a free, stand-alone implementation of Oracle Database Client. Oracle Instant Client is not based in an Oracle home directory and requires less disk space than Oracle Database Client.

5.1.3 About the Client Packages and Client Supporting Packages

The Oracle R Enterprise client packages and client supporting packages are required on each client computer and on the server computer that hosts Oracle Database with Oracle R Enterprise Server. On the server, the client packages are installed automatically by the Oracle R Enterprise Server installation script.

5.1.3.1 Oracle R Enterprise Client Packages

The client packages, shown in Table 5-1, are a set of Oracle proprietary packages that support Oracle R Enterprise.

Table 5-1 Oracle R Enterprise Client Packages

Package Name Description

ORE

The top-level package for Oracle R Enterprise.

OREbase

Corresponds to the open source R base package.

OREdm

Exposes Oracle Data Mining algorithms through R.

OREeda

Contains functions for exploratory data analysis.

OREgraphics

Corresponds to the open source R graphics package.

OREmodels

Contains functions for advanced analytical modeling.

OREpredict

Enables scoring data in Oracle Database using R models.

OREstats

Corresponds to the open source R stats package.

ORExml

Supports XML translation between R and Oracle Database.


5.1.3.2 Oracle R Enterprise Client Supporting Packages

The client supporting packages, shown in Table 5-2, are a set of open source packages that support the Oracle R Enterprise client packages.

Table 5-2 Oracle R Enterprise Client Supporting Packages

Package Name Description

DBI

A database interface definition for communication between R and Oracle Database.

png

Supports the reading and writing PNG images for Oracle R Enterprise objects.

ROracle

Oracle Database interface for R based OCI.


5.2 Installing Oracle Database Instant Client on Windows

As described in Section 5.1.2, Oracle R Enterprise requires Oracle Database client software. Oracle Instant Client is suitable for most configurations of Oracle R Enterprise.

To Install Oracle Instant Client on Windows: 

  1. Create an installation directory for the Oracle R Enterprise client components. For example:

    c:\oreclient_install_dir
    
  2. Go to the Oracle Database Instant Client page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/features/instant-client/

  3. Select See Instant Client downloads for all platforms.

  4. On the Instant Client Downloads page, select Instant Client for Microsoft Windows (x64).

  5. On the Instant Client Downloads for Microsoft Windows (x64) page, accept the license agreement.

  6. Choose Instant Client Package - Basic or Instant Client Package - Basic Lite for your version of Oracle Database.

  7. Save the file in the installation directory that you created in Step 1. For example:

    c:\oreclient_install_dir\instantclient-basic-windows.x64-12.1.0.1.0.zip
    
  8. Unzip the file.The files are extracted into a subdirectory called instantclient_version, where version is your version of Oracle Database. For example:

    c:\oreclient_install_dir\instantclient_12_1
    
  9. Return to the Instant Client Downloads for Microsoft Windows (x64) page:

    http://www.oracle.com/technetwork/topics/winx64soft-089540.html

  10. Accept the license agreement and select Instant Client Package - SDK for your version of Oracle Database.

  11. Save the file in the installation directory that you created in Step 1.

    c:\oreclient_install_dir\instantclient-sdk-windows.x64-12.1.0.1.0.zip
    
  12. Unzip the file. The files are extracted into the instantclient_version subdirectory. An Instant Client installation directory for Oracle Database 12.1 is shown in Figure 5-1

    Figure 5-1 An Instant Client Installation Directory for Oracle Database 12.1

    Description of Figure 5-1 follows
    Description of "Figure 5-1 An Instant Client Installation Directory for Oracle Database 12.1"

  13. Add the full path of the Instant Client to the environment variables OCI_LIB64 and PATH. The following steps set the variables to the path used in this example, c:\myoreclient\instantclient_12_1:

    To set environment variables for Oracle Instant Client: 

    1. In Windows Control Panel, choose System.

    2. Click Advanced systems settings.

    3. On the Advanced tab, click Environment Variables.

    4. Under System variables, create OCI_LIB64 if it does not already exist. Set the value of OCI_LIB64 to c:\oreclient\instantclient_12_1.

    5. Under System variables, edit PATH to include c:\oreclient\instantclient_12_1.

      Note:

      The graphical user interface for creating environment variables may vary slightly, depending on your version of Windows.

5.3 Installing Oracle Database Instant Client on Linux or UNIX

As described in Section 5.1.2, Oracle R Enterprise requires Oracle Database client software. Oracle Instant Client is suitable for most configurations of Oracle R Enterprise.

This section contains these topics:

5.3.1 Installing Oracle Instant Client on Linux from RPMs

To Install Oracle Instant Client on Linux from RPMs: 

  1. Create an installation directory for the Oracle R Enterprise client components. For example:

    % mkdir oreclient_install_dir
    
  2. Go to the Oracle Database Instant Client page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/features/instant-client/

  3. Choose See Instant Client downloads for all platforms.

  4. On the Instant Client Downloads page, choose Instant Client for Linux x86-64.

  5. On the Instant Client Downloads page for Linux, accept the license agreement and select the RPM for Instant Client Package - Basic or the Instant Client Package - Basic Lite.

  6. Save the file in the directory that you created in Step 1. For example:

    ~/oreclient_install_dir/oracle-instantclient12.1-basic-12.1.0.1.0-1.x86_64.rpm
    
  7. Return to the Instant Client Downloads page for Linux x86-64:

    http://www.oracle.com/technetwork/topics/linuxx86-64soft-092277.html

  8. Accept the license agreement and download the RPM for Instant Client Package - SDK for your version of Oracle Database. Save the file in directory that you created in Step 1. For example:

    ~/oreclient_install_dir/oracle-instantclient12.1-sdk-12.1.0.1.0-1.x86_64.rpm
    
  9. The RPMs place the files in standard locations that the ROracle configuration script can find. For example, Oracle Instant Client 12.1 will be installed in/usr/lib/oracle/12.1/client64/lib.

  10. After installing Oracle Instant Client, change LD_LIBRARY_PATH to include the Oracle Instant client libraries. For example:

    % export LD_LIBRARY_PATH=/usr/lib/oracle/12.1/client64/lib:$LD_LIBRARY_PATH
    

5.3.2 Installing Oracle Instant Client on Linux or UNIX from a Zip File

To Install Oracle Instant Client on Linux or UNIX for a zip file: 

  1. Create an installation directory for the Oracle R Enterprise client components. For example:

    % mkdir oreclient_install_dir
    
  2. Go to the Oracle Database Instant Client page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/features/instant-client/

  3. Select See Instant Client downloads for all platforms. On the Instant Client Downloads page, select the Instant Client for your platform.

  4. Accept the license agreement and select the Instant Client Package - Basic or Instant Client Package - Basic Lite rpm for your version of Oracle Database.

  5. Save the file in the installation directory that you created in Step 1. For example:

    ~\oreclient_install_dir\instantclient-basic-linux.x64-12.1.0.1.0.zip
    
  6. Unzip the file. The files are extracted into a subdirectory called instantclient_version, where version is your version of Oracle Database. For example:

    % unzip instantclient-basic-linux.x64-12.1.0.1.0.zip
    % ls
    instantclient_12_1/
    instantclient-basic-linux.x64-12.1.0.1.0.zip
    
  7. Return to the Instant Client Downloads page:

    http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html

  8. Select the Instant Client for your platform.

  9. On the Instant Client Downloads page for your platform, accept the license agreement and select Instant Client Package - SDK for your version of Oracle Database.

  10. Save the file in the installation directory that you created in Step 1. For example:

    ~\oreclient_install_dir\instantclient-sdk-linux.x64-12.1.0.1.0.zip
    
  11. Unzip the file. The contents are extracted into the instantclient_version subdirectory.

    % unzip instantclient-sdk-linux.x64-12.1.0.1.0.zip
    % ls
    /instantclient_12_1
    instantclient-basic-linux.x64-12.1.0.1.0.zip
    instantclient-sdk-linux.x64-12.1.0.1.0.zip
    % cd instantclinet_12_1
    % ls
    /help
    /sdk
    /vc10
    /vc11
    

5.4 Installing the Client Packages on Windows

Install the Oracle R Enterprise client packages on each client computer. The client packages are automatically included in the installation on the server.

This section contains these topics:

5.4.1 Downloading the Client Packages on Windows

To download the client packages: 

  1. Go to the Oracle R Enterprise Downloads page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/options/advanced-analytics/r-enterprise/ore-downloads-1502823.html

  2. Accept the License Agreement.

  3. Choose Oracle R Enterprise Client Packages for Windows Platform. Download and save the file in the installation directory that you created for Oracle Instant Client. For example:

    c:\oreclient_install_dir\ore-client-win-x86_64-1.3.1.zip
    

    Note:

    Choose the same installation directory for all Oracle R Enterprise client components.
  4. Unzip the file. The contents are extracted into the client subdirectory:

    The resulting installation directory, shown in Example 5-1, contains Oracle Instant Client and Oracle R Enterprise client packages.

    Example 5-1 Client Installation Directory Containing Client Packages and Instant Client

    c:\oreclient_install_dir
         \client
              \ORE_1.3.1.zip
              \OREbase_1.3.1.zip
              \OREdm_1.3.1.zip
              \OREeda_1.3.1.zip
              \OREgraphics_1.3.1.zip
              \OREpredict_1.3.1.zip
              \OREstats_1.3.1.zip
              \ORExml_1.3.1.zip
         \instantclient_12_1
    instantclient-basic-linux.x64-12.1.0.1.0.zip
    instantclient-sdk-linux.x64-12.1.0.1.0.zip
    ore-client-win-x86_64-1.3.1.zip
    

5.4.2 Installing the Client Packages on Windows

Choose one of the following methods to install the Oracle R Enterprise client packages on Windows:

5.4.2.1 Installing the Client Packages from the R Console

  1. Start R x64 from the Windows Start menu.

  2. Execute this R command for each zip file in the client directory:

    R> install.packages("oreclient_install_dir/client/client_package_name.zip', repos=NULL)
    

    Each successful package installation produces this message in the R console:

    package 'package_name' successfully unpacked and MD5 sums checked
    

5.4.2.2 Installing the Client Packages from the R GUI

  1. Start R x64 from the Windows Start menu.

  2. Select Packages from the RGui (64-bit) menu bar.

  3. From the Packages menu, select Install package(s) from local zip files.

  4. Change to the client directory.

  5. Select all the files in the directory.

  6. Click Open.

    Each package installation produces this message in the R console:

    package 'package_name' successfully unpacked and MD5 sums checked
    

5.4.2.3 Installing the Client Packages from the Windows Command Prompt

  1. Start R x64 from the Windows Start menu.

  2. Open a Windows command window.

  3. Change directory to the client directory and type these commands:

    > R CMD INSTALL OREbase_1.3.1.zip
    > R CMD INSTALL OREstats_1.3.1.zip
    > R CMD INSTALL OREgraphcs_1.3.1.zip
    > R CMD INSTALL OREeda_1.3.1.zip
    > R CMD INSTALL ORExml_1.3.1.zip
    > R CMD INSTALL OREdm_1.3.1.zip
    > R CMD INSTALL OREpredict_1.3.1.zip
    > R CMD INSTALL ORE_1.3.1.zip
    

    Each package installation generates this message:

    package 'package_name' successfully unpacked and MD5 sums checked
    

5.5 Installing the Client Supporting Packages on Windows

Install the Oracle R Enterprise client supporting packages on each client computer and on the server computer.

This section contains these topics:

5.5.1 Downloading the Client Supporting Packages on Windows

To download the client supporting packages: 

  1. Go to the Oracle R Enterprise Downloads page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/options/advanced-analytics/r-enterprise/ore-downloads-1502823.html

  2. Accept the License Agreement.

  3. Choose Oracle R Enterprise Client Supporting Packages for Windows Platform. Download and save the file in the Oracle R Enterprise client installation directory For example:

    c:\oreclient_install_dir\ore-supporting-win-x86_64-1.3.1.zip
    

    Note:

    Choose the same installation directory for all Oracle R Enterprise client components.
  4. Unzip the file. The contents are extracted into the supporting subdirectory:

    The resulting installation directory, shown in Example 5-2, contains all the client components: Oracle Instant Client, Oracle R Enterprise client packages, and Oracle R Enterprise client supporting packages.

    Example 5-2 Client Installation Directory Containing All Client Components

    c:\oreclient_install_dir
         \client
         \instantclient_12_1
         \supporting     
             \DBI_0.2-5.zip
             \png_0.1-4.zip
             \ROracle_1.1-9.zip
    instantclient-basic-linux.x64-12.1.0.1.0.zip
    instantclient-sdk-linux.x64-12.1.0.1.0.zip
    ore-client-win-x86_64-1.3.1.zip
    ore-supporting-win-x86_641.3.1.zip
    

5.5.2 Installing the Client Supporting Packages on Windows

Choose one of the following methods to install the Oracle R Enterprise client supporting packages on Windows:

5.5.2.1 Installing the Client Supporting Packages from the R Console

  1. Start R x64 from the Windows Start menu.

  2. Execute this command for each zip file in the supporting directory:

    R> install.packages("oreclient_install_dir\support\support_package_name.zip",
                         repos=NULL)
    

Each package installation produces this message in the R console:

package 'package_name' successfully unpacked and MD5 sums checked

5.5.2.2 Installing the Client Supporting Packages Using the R GUI

  1. Start R x64 from the Windows Start menu.

  2. From the main menu, select Packages.

  3. Select Install package(s) from local zip files.

  4. Browse to \oreclient_install_dir\supporting.

  5. Select all of the files in the directory.

  6. Click Open.

Each package installation produces this message in the R console:

package 'package_name' successfully unpacked and MD5 sums checked

5.5.2.3 Installing the Client Supporting Packages from the Windows Command Prompt

  1. Start R x64 from the Windows Start menu.

  2. Open a command window.

  3. Change to \oreclient_install_dir\supporting directory and type these commands:

    > R CMD INSTALL ROracle_1.1-9.zip
    > R CMD INSTALL DBI_0.2-5.zip
    > R CMD INSTALL png_0.1-4.zip
    

    Each package installation produces this message in the R console:

    package 'package_name' successfully unpacked and MD5 sums checked
    

5.6 Installing the Client Packages on Linux or UNIX

Install the Oracle R Enterprise client packages on each client computer. The client packages are automatically included in the installation on the server.

5.6.1 Downloading the Client Packages on Linux or UNIX

To download the client packages: 

  1. Go to the Oracle R Enterprise Downloads page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/options/advanced-analytics/r-enterprise/ore-downloads-1502823.html

  2. Accept the License Agreement.

  3. Choose Oracle R Enterprise Client Packages for your platform. Download and save the file in the installation directory that you created for Oracle Instant Client. For example:

    ~/oreclient_install_dir/ore-client-platform-arch.zip
    

    Note:

    Choose the same installation directory for all Oracle R Enterprise client components.
  4. Unzip the file:

    % unzip ore-client-platform-arch.zip
    

    When you unzip the file, the /client directory is created and these files are extracted.

    /client/ORE_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/OREbase_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/OREdm_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/OREeda_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/OREgraphics_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/OREpredict_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/OREstats_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    /client/ORExml_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    

5.6.2 Installing the Client Packages on Linux or UNIX

To install the client packages: 

  1. Change to /oreclient_install_dir/client.

  2. Execute the following commands:

    % R CMD INSTALL ORE_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL OREbase_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL OREdm_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL OREeda_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL OREgraphics_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL OREpredict_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL OREstats_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    % R CMD INSTALL ORExml_1.3.1_R_arch-unknown-platform-gnu.tar.gz
    

5.7 Installing the Client Supporting Packages on Linux or UNIX

Install the Oracle R Enterprise client supporting packages on each client computer and on the server computer that hosts Oracle R Enterprise Server.

5.7.1 Downloading the Client Supporting Packages on Linux or UNIX

To download the client supporting packages: 

  1. Go to the Oracle R Enterprise Downloads page on the Oracle Technology Network:

    http://www.oracle.com/technetwork/database/options/advanced-analytics/r-enterprise/ore-downloads-1502823.html

  2. Accept the License Agreement.

  3. Choose Oracle R Enterprise Client Supporting Packages for your platform. Download and save the file in the client installation directory. For example:

    ~/oreclient_install_dir/ore-supporting-platform_arch.zip
    

    Note:

    Choose the same installation directory for all Oracle R Enterprise client components.
  4. Unzip the file:

    % unzip ore-supporting-platform_arch.zip
    

    When you unzip the file, the supporting directory is created and these files are extracted.

    /supporting/DBI_0.2-5_R_arch-unknown-platform.tar.gz
    /supporting/png_0.1-4_R_arch-unknown-platform.tar.gz
    /supporting/ROracle_1.1-9_R_arch-unknown-platform.tar.gz
    

5.7.2 Installing the Client Supporting Packages on Linux or UNIX

To install the client supporting packages: 

  1. Change directory to /oreclient_install_dir/supporting.

  2. Execute these commands:

    % R CMD INSTALL DBI_0.2-5_R_arch-unknown-platform.tar.gz
    % R CMD INSTALL ROracle_1.1-9_R_arch-unknown-platform.tar.gz
    % R CMD INSTALL png_0.1-4_R_arch-unknown-platform.tar.gz