metvurst now a package, repository moved to GitHub

Inspired by a post on PirateGrunt, I finally managed to pack metvurst up and turn it into a proper R-Package (the fact that I’m on holiday and have some time also helped). As a side-effect of this, the repository has been moved from google code to GitHub. As I use RStudio for developping R-code, this shift seemed inevitable, as the integration of git in the package development tools in RStudio is very handy.

In order to install metvurst you need to have devtools. Making use of devtools install_github() function you can easily install and load metvurst:

library(devtools)
install_github('metvurst', 'tim-salabim')
library(metvurst)

I have tried it on Linux and Mac so far, so in case there are any problems on Windows, please let me know (a quick note if indeed it does work on Windows would be appreciated too).

For now, the two core functions strip() and windContours() along with some helper functions (mainly to convert wind speed and direction to u and v components and vice versa) are included.

The package is fully functional but there is no documentation for now. I will progressively add and update documentation manuals over the next few weeks (maybe months, depending on how busy I am once I return to work).

Have fun using metvurst and in case you have any questions, suggestions or critique don’t hesitate to get in touch.

Cheers

TimSalabim

About these ads
This entry was posted in Uncategorized. Bookmark the permalink.

2 Responses to metvurst now a package, repository moved to GitHub

  1. very happy that you have started blogging. thanks so much for sharing so many techniques from a different discipline that I have been able to plug right into my toolbox. Please keep going.

  2. tonycaine says:

    fyi.
    Windows install (using 3 lines from blog) did not succeed..oops.
    - devtools installed- successfully, but install_github() step did not
    – listing 1. below

    - cloned from Githuh manually – THANKS
    - build via RStudio – seems to have worked – dispite complaining about RTools
    – listing 2. below
    tony
    ———————–

    listing 1. (command output install_github() step
    ——————
    > install_github(‘metvurst’, ‘tim-salabim’)
    Installing github repo(s) metvurst/master from tim-salabim
    Installing metvurst.zip from https://api.github.com/repos/tim-salabim/metvurst/zipball/master
    Installing metvurst
    C:/PROGRA~1/R/R-215~1.1/bin/i386/R –vanilla CMD build \
    “C:\Users\tcaine\AppData\Local\Temp\RtmpQFo94b\tim-salabim-metvurst-7a42d5c” –no-manual \
    –no-resave-data

    * checking for file ‘C:\Users\tcaine\AppData\Local\Temp\RtmpQFo94b\tim-salabim-metvurst-7a42d5c/DESCRIPTION’ … OK
    * preparing ‘metvurst’:
    * checking DESCRIPTION meta-information … OK
    * checking for LF line-endings in source and make files
    * checking for empty or unneeded directories
    * building ‘metvurst_1.0.tar.gz’
    ERROR
    packaging into .tar.gz failed
    Error: Command failed (1)
    In addition: Warning message:
    running command ‘”C:/PROGRA~1/R/R-215~1.1/bin/i386/R” –vanilla CMD build “C:\Users\tcaine\AppData\Local\Temp\RtmpQFo94b\tim-salabim-metvurst-7a42d5c” –no-manual –no-resave-data’ had status 1

    listing 2. (rstudio build log)
    ———————–
    ==> Rcmd.exe INSTALL –no-multiarch metvurst

    * installing to library ‘C:/Program Files/R/R-2.15.1/library’
    * installing *source* package ‘metvurst’ …
    ** R
    ** preparing package for lazy loading
    ** help
    Warning: C:/_store/@stats/metvurst/metvurst/man/metvurst-package.Rd:30: All text must be in a section
    Warning: C:/_store/@stats/metvurst/metvurst/man/metvurst-package.Rd:31: All text must be in a section
    *** installing help indices
    ** building package indices
    ** testing if installed package can be loaded

    * DONE (metvurst)
    WARNING: Rtools is required to build R packages however is not currently installed. Please download and install the appropriate version of Rtools before proceeding:

    http://cran.r-project.org/bin/windows/Rtools/

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s