R/report.R

In cboettig/socialR: Social functions for R

#report.R
# Gathers run information and synthesizes common calls


# could pass flickr opts with a do.call as well...
upload <- function(images, script="", comment="", tags="", public=TRUE, 
                   flickr_user = "cboettig", save=TRUE, tweet=FALSE,
                   gitaddr=gitcommit(script)){ 
                  
## Uploads images with links to code, saves data matching image name
## Args:
##   images: list of .png or .jpg files to upload
##   script: name of the current script, just used as link text
## Example:

  if(script=="") # if not given, use the text "link" for the link
    script <- "link"
  source <- paste("<a href=\"", gitaddr, "\">view sourcecode, ",
                  script, "</a>", sep="") 
  flickr_id <- flickr(files=images, description=paste(source, comment),
                      tags=tags, public=public)
  if(tweet){
    cpu <- get_cpu_name() #From which machine
    runtime <- gettime()
    flickraddr <- flickr_url(flickr_id, user=flickr_user)
    tweet(paste(script, "From", cpu, ". View:", shorturl(flickraddr), "source:",
          shorturl(gitaddr),"runtime: ", runtime, " ", names(runtime)), 
          tags=c(tags, cpu))
  }

  if(save){
    env <- .GlobalEnv 
    save(list=ls(env), file=paste(flickr_id, ".Rdat", sep=""))
		print(paste("datafile saved as ", flickr_id, ".Rdat", sep=""))
  }
}














############ DEPRICATED ####################
## all-in-one reporting, uploads specified files or just tweets the data
social_report <- function(files=NULL, comment=" ", tags = "", guess_tags=FALSE, public=TRUE, save=TRUE, global=TRUE){

	log <- gitlog()
  flickr_id <- flickr(files, tags=tags, description=
                      paste(comment,log$commitID), public=public )
  tweet(comment=comment, tags=tags)

	if(save){
    if(global)
      env <- .GlobalEnv
    else 
      env <- parent.env(parent.env(environment())) # If this function is being called by social_plot, this is true?
    save(list=ls(env), file=paste(flickr_id, ".Rdat", sep=""))
		print(paste("datafile saved as ", flickr_id, ".Rdat", sep=""))
	}
	flickr_id
}

## A function that can be wrapped around a plot command to autoreport it
social_plot <- function(plotcmd, file=NULL, comment="", tags="",
                        device=c("png"), public=TRUE, save=TRUE, ...){
	if(is.null(file)){
		if(device == "png"){ 
			png("autoplot.png", ...)
			file <- "autoplot.png"
		}
		else { 
      printf("device type not recognized") 
      return(0) 
    }
	} else {
		if(device == "png"){
      png(file, ...)
    } else { 
      printf("device type not recognized") 
      return(0) 
    }
	}
	plotcmd
	dev.off()
	social_report(files=file, comment=comment, tags=tags,
                public=public, save=save, global=FALSE)
}