Difference between revisions of "OpasnetBaseUtils"

From Testiwiki
Jump to: navigation, search
m (Instructions)
m (See also: jeps)
Line 50: Line 50:
  
 
*[[File:OpasnetBaseUtils v.0.8.2 source.zip|OpasnetBaseUtils sources]]
 
*[[File:OpasnetBaseUtils v.0.8.2 source.zip|OpasnetBaseUtils sources]]
**To build from source use "R CMD build" & "R CMD install" in a command line on properly configured machines (most Unix systems require no configuration)
+
**To build from source use "R CMD build <src folder>" & "R CMD INSTALL <src folder>" in a command line on properly configured machines (most Unix systems require no configuration)

Revision as of 11:35, 10 May 2011


Scope

OpasnetBaseUtils is a collection of R functions for interaction with the Opasnet Base and manipulating data of multiple variables with multiple matching or unmatching dimensions, fitted into a neat package. What should such a package contain?

Rationale

A suggestion about the structure and content:

There should be just one package (at least for the time being) from Opasnet developers, namely OpasnetUtils. This contains different things:

  • OpasnetBaseUtils for connections to and from Opasnet Base.
    • Suggested function names: opbase.read (previously op_baseGetData), opbase.write (previously op_baseWrite).

--# : The original distinction between Write and GetData arose from the fact that data isn't the only thing read from the base. GetLocs also exists for getting location info on a particular data set. Of course GetLocs could be renamed locs or locations, but that loses some of the information contained in the function names. --Teemu R 09:25, 9 May 2011 (EEST)

  • Functions for some particular tasks needed in Opasnet assessments, such as functions for calculating health impacts from ERF (the function takes in RR or OR or both and automatically calculates a synthesis), exposure and background disease.
    • Suggested function names: ophia.lifetable (for life table calculation), ophia.hia (for simple impact calculation), opgis.population (for slicing population data from a database for a case), opmath.sip and opmath.unsip (for turning a random sample into a SIP and a SIP into a random sample, respectively, etc.
  • Outdated functions for compatibility reasons, such as IntArray.
  • Functions or practices for handling uncertain variables: how to merge run/obs index into a data.frame.

If the suggestion is accepted, the following things could be done to organise pages:

# : This does not seem wise, my previous experience is that files downloaded from Opasnet are cached in some very special place and I was unable to download the most recent version of a certain file, because of the similar filename. Also I think any programmer would agree that it'd be bad practice to not include an easily accessible version number on the file. --Teemu R 09:25, 9 May 2011 (EEST)

Instructions

  1. Download File:OpasnetBaseUtils 0.8.2.zip
  2. Open R
  3. Click "Packages" on the topbar and choose "Install package(s) from local zip files..." from the drop-down menu
  4. Locate the downloaded .zip file and install

Usage

library(OpasnetBaseUtils)

Dependencies

  • You need to have installed another package called RODBC which in turn requires the utils package. These packages are available from the CRAN repositories and can be easily installed from within R.

See also

  • File:OpasnetBaseUtils v.0.8.2 source.zip
    • To build from source use "R CMD build <src folder>" & "R CMD INSTALL <src folder>" in a command line on properly configured machines (most Unix systems require no configuration)