Difference between revisions of "R and Calc"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<blockquote style="background: white; border: 1px solid rgb(153, 153, 153); padding: 1em;">This page is meant as a general overview and installation guide for the software. Please see [[R and Calc Documentation]] for more information on functions, scripting, and general usage. Also feel free to submit bug reports in the [[R and Calc: Bugs and Feature Requests]] page, and provide feedback at the [http://extensions.services.openoffice.org/project/R4Calc extension page].</blockquote>
 +
 
"R and Calc" is an [[OpenOffice.org]] (OO.o) [[Calc]] add-on that allows you to use [http://www.r-project.org/ R] methods and functions. The software is currently in early development, though a '''basic''' working version does exist, and is available for download.
 
"R and Calc" is an [[OpenOffice.org]] (OO.o) [[Calc]] add-on that allows you to use [http://www.r-project.org/ R] methods and functions. The software is currently in early development, though a '''basic''' working version does exist, and is available for download.
  
Line 4: Line 6:
  
 
For those who come here often, here is the latest version:
 
For those who come here often, here is the latest version:
* '''Version:''' 0.1.0
+
* '''Version:''' 0.1.12
* '''Release Date:''' May 15, 2007 (12:33 am)
+
* '''Release Date:''' February 23, 2008 (5:20 am EST)
* '''Link:'''  
+
* '''Link:''' http://www.11-55.org/rcalc/2008-02-23/RAddon.uno.pkg
* '''Source Code:'''  
+
* '''Source Code:''' http://www.11-55.org/rcalc/2008-02-23/rcalc-0_1_12.zip
 +
* '''Manual:''' http://www.11-55.org/rcalc/2008-02-23/manual.pdf (a [http://researchonresearch.blogspot.com/2008/03/r4calc.html screencast] is also available)
  
 
==Requirements==
 
==Requirements==
Line 13: Line 16:
 
You need the following software to run this add-on. While older versions may suffice, they have not been tested yet.
 
You need the following software to run this add-on. While older versions may suffice, they have not been tested yet.
 
* OpenOffice.org 2.1
 
* OpenOffice.org 2.1
* Java 1.5.0
+
* Java 5.0
 +
* RServe 0.4.7
  
 
==Installing==
 
==Installing==
Line 28: Line 32:
 
* Rserve()
 
* Rserve()
  
Now that you have the prerequisites installed, download the package RAddon.uno.pkg (zipped file). Unzip the file, and let's call the directory you unzipped it in <RA_DIR>. Now let <OO_HOME> be your OpenOffice.org installation directory. Open the command prompt or terminal window and go to <OO_HOME>/program/ and type:
+
Now that you have the prerequisites installed, download the package RAddon.uno.pkg (linked above). Unzip the file, and let's call the directory you unzipped it in <RA_DIR>. Now let <OO_HOME> be your OpenOffice.org installation directory. Open the command prompt or terminal window and go to <OO_HOME>/program/ and type:
  
 
* unopkg add <RA_DIR>/RAddon.uno.pkg
 
* unopkg add <RA_DIR>/RAddon.uno.pkg
  
You should now be done!
+
If this is not your first time installing the add-in, you need to check if a previous version is also on the system. If it is, then you will not be able to install the new version. To do this, go to <OO HOME>/program and type:
 +
 
 +
* unopkg list
 +
 
 +
This will show you the list of packages already installed, and you should be able to check if the add-is is there. Remember to look for "RAddon.uno.pkg". You can also skip this step and try to uninstall RAddon.uno.pkg regardless -- this will not harm your OpenOffice.org installation in any way, even if RAddon.uno.pkg is abset. To do this, type:
 +
 
 +
* unopkg remove RAddon.uno.pkg
 +
 
 +
Finally, some operating systems require that you restart your OpenOffice.org installation (if you're not sure, restart your computer) to be able to see the cell functions that come with this package.
  
 
==Using==
 
==Using==
Line 45: Line 57:
 
==Testing==
 
==Testing==
  
So far, the software has been tested on the following. Brackets describe the latest version tested on each system:
+
So far, the software has been tested on the following.
  
* Fedora Core 6 (0.1.0)
+
===Version 0.1.7===
* Ubuntu Edgy Eft (0.1.0)
+
  
==Known Issues==
+
* 64-bit Gentoo Linux running JDK 1.5.0.12 (64-bit version), OpenOffice 2.2.1, and R 2.4.1
  
Yes, we already have some known issues! That's OK, these are common issues and are not problematic with regards to the code:
+
===Version 0.1.6===
  
* '''Issue #1:''' Strings and characters, when part of the R object model, do not get published in Rdump().
+
* Ubuntu Feisty Fawn on Java 1.6.0
 +
 
 +
===Version 0.1.5===
 +
 
 +
* Fedora Core 7 running native Java
 +
* Ubuntu Edgy Eft running SDK 1.5.0_08 and OpenOffice 2.1.
 +
* Windows XP SP2 running running JDK 1.6.0_02 and OpenOffice 2.2.
 +
 
 +
===Version 0.1.0===
 +
 
 +
* Fedora Core 6 running JDK 1.6.0_01 and OpenOffice 2.2.
 +
* Ubuntu Edgy Eft running SDK 1.5.0_08 and OpenOffice 2.1.
 +
* Windows XP running running JDK 1.6.0_01 and OpenOffice 2.2.
  
 
==About==
 
==About==
  
 
This add-on is the result of a Google [[Summer of Code 2007]] project. It was initially created by [[User:Wojciech|Wojciech Gryc]]. For information pertaining to the development of this add-on, see [http://www.11-55.org/ooblog/ Wojciech's Blog].
 
This add-on is the result of a Google [[Summer of Code 2007]] project. It was initially created by [[User:Wojciech|Wojciech Gryc]]. For information pertaining to the development of this add-on, see [http://www.11-55.org/ooblog/ Wojciech's Blog].
 +
 +
==Older Versions==
 +
 +
* '''0.1.11''' [http://www.11-55.org/rcalc/2007-10-08/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-10-08/rcalc-0_1_11.zip Source Code])
 +
* '''0.1.10''' [http://www.11-55.org/rcalc/2007-09-08/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-09-08/rcalc-0_1_10.zip Source Code])
 +
* '''0.1.9''' [http://www.11-55.org/rcalc/2007-09-04_2/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-09-04_2/rcalc-0_1_9.zip Source Code])
 +
* '''0.1.8''' [http://www.11-55.org/rcalc/2007-09-04/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-09-04/rcalc-0_1_8.zip Source Code])
 +
* '''0.1.7''' [http://www.11-55.org/rcalc/2007-08-23/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-08-23/rcalc-0_1_7.zip Source Code])
 +
* '''0.1.6''' [http://www.11-55.org/rcalc/2007-08-19/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-08-19/rcalc-0_1_6.zip Source Code])
 +
* '''0.1.5''': [http://www.11-55.org/rcalc/2007-08-16/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-08-16/rcalc-0_1_5.zip Source Code])
 +
* '''0.1.4''': [http://www.11-55.org/rcalc/2007-08-10/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-08-10/rcalc-0_1_4.zip Source Code])
 +
* '''0.1.3''': [http://www.11-55.org/rcalc/2007-08-02/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-08-02/rcalc-0_1_3.zip Source Code])
 +
* '''0.1.2''': [http://www.11-55.org/rcalc/2007-06-01/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-06-01/rcalc-0_1_2.zip Source Code])
 +
* '''0.1.1''': [http://www.11-55.org/rcalc/2007-05-25/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-05-25/rcalc-0_1_1.zip Source Code])
 +
* '''0.1.0''': [http://www.11-55.org/rcalc/2007-05-15/RAddon.uno.pkg UNO Package] ([http://www.11-55.org/rcalc/2007-05-15/rcalc-0.1.0.zip Source Code])
 +
 +
[[Category:Calc]]
 +
[[Category: R and Calc]]

Latest revision as of 06:25, 19 March 2008

This page is meant as a general overview and installation guide for the software. Please see R and Calc Documentation for more information on functions, scripting, and general usage. Also feel free to submit bug reports in the R and Calc: Bugs and Feature Requests page, and provide feedback at the extension page.

"R and Calc" is an OpenOffice.org (OO.o) Calc add-on that allows you to use R methods and functions. The software is currently in early development, though a basic working version does exist, and is available for download.

We welcome any and all comments and name suggestions. Please send them to Wojciech Gryc.

For those who come here often, here is the latest version:

Requirements

You need the following software to run this add-on. While older versions may suffice, they have not been tested yet.

  • OpenOffice.org 2.1
  • Java 5.0
  • RServe 0.4.7

Installing

The current version is a prototype and implements only one tool: RDUMP. This method is accessed through the actual Calc menu, and allows you to see the R object structure for various method calls.

To use the add-on, you need to install R and Rserve. Instructions for installing R can be found at http://www.r-project.org/ Once installed, run R and type the following to install Rserve. Click "enter" at the end of each bullet point:

  • install.packages("Rserve")

Rserve needs to be running to work, and can be launched with the following commands... Note that you only need to do this when you want to use the R Add-on for Calc.

  • library(Rserve)
  • Rserve()

Now that you have the prerequisites installed, download the package RAddon.uno.pkg (linked above). Unzip the file, and let's call the directory you unzipped it in <RA_DIR>. Now let <OO_HOME> be your OpenOffice.org installation directory. Open the command prompt or terminal window and go to <OO_HOME>/program/ and type:

  • unopkg add <RA_DIR>/RAddon.uno.pkg

If this is not your first time installing the add-in, you need to check if a previous version is also on the system. If it is, then you will not be able to install the new version. To do this, go to <OO HOME>/program and type:

  • unopkg list

This will show you the list of packages already installed, and you should be able to check if the add-is is there. Remember to look for "RAddon.uno.pkg". You can also skip this step and try to uninstall RAddon.uno.pkg regardless -- this will not harm your OpenOffice.org installation in any way, even if RAddon.uno.pkg is abset. To do this, type:

  • unopkg remove RAddon.uno.pkg

Finally, some operating systems require that you restart your OpenOffice.org installation (if you're not sure, restart your computer) to be able to see the cell functions that come with this package.

Using

Using the add-on is very simple at this stage. To see the tool at work, open Calc. In the menus, go to R Add-on > Rdump(). A new dialog window will pop up. Type in an R script -- here are some examples:

  • rnorm(10)
  • cor.test(c(1,2,3,4), c(1,2,2,3))

Then click "Run". A new sheet should appear. Close the dialog with "Close" and check the new sheet -- you should see various pieces of information on the sheet.

Testing

So far, the software has been tested on the following.

Version 0.1.7

  • 64-bit Gentoo Linux running JDK 1.5.0.12 (64-bit version), OpenOffice 2.2.1, and R 2.4.1

Version 0.1.6

  • Ubuntu Feisty Fawn on Java 1.6.0

Version 0.1.5

  • Fedora Core 7 running native Java
  • Ubuntu Edgy Eft running SDK 1.5.0_08 and OpenOffice 2.1.
  • Windows XP SP2 running running JDK 1.6.0_02 and OpenOffice 2.2.

Version 0.1.0

  • Fedora Core 6 running JDK 1.6.0_01 and OpenOffice 2.2.
  • Ubuntu Edgy Eft running SDK 1.5.0_08 and OpenOffice 2.1.
  • Windows XP running running JDK 1.6.0_01 and OpenOffice 2.2.

About

This add-on is the result of a Google Summer of Code 2007 project. It was initially created by Wojciech Gryc. For information pertaining to the development of this add-on, see Wojciech's Blog.

Older Versions

Personal tools