archived functions/useWizard.R

In michaelgavin/tei2r: Import and parse TEI files in R

#====================================================================
# This function simplifies the construction of the docList object by
# prompting the user for all required values and returning the completed
# object to the buildDocList function.
# Should only be accessed through the buildDocList function.
#====================================================================
# Setup wizard
# 
# 
# @param dl           The empty \code{docList} object that is created in
#                     the \code{buildDocList} function and that is constructed
#                     in this function.  The object is returned to the
#                     \code{buildDocList} function.
# @param directory    The directory in which the corpus files are stored.  Passing
#                     a value in for this parameter is optional and saves the user
#                     from being asked for their directory if they have already
#                     provided it.
#                     
# @section What it does:
# This function walks the user through the process of building a
# \code{docList} object.  It preforms the same functionality of
# the \code{buildDocList} function, but is interactive and works
# in a more simple way.  This function should \emph{only} be called
# by using the \code{wizard = T} parameter of the \code{buildDocList}
# function.
useWizard <- function(dl, directory = "") {
  print("Thank you for choosing the wizard option. This wizard is designed to walk you through setting up your corpus and docList object.")
  if(directory == "") {
    directory <- readline("To get started, what is the directory that you
                         have your files stored in? [full path] > ")
    if(substr(directory, 1, 1) == '\"') {
      directory = substr(directory, 2, nchar(directory)-1)
    }
    #browser()
    if(!is.na(directory) && file.info(directory)$isdir == TRUE) {
      dl@directory = directory
    } else {
      while(file.info(directory)$isdir == FALSE) {
        directory <- readline("That doesn't appear to be a directory, please
                              try again. > ")
      }
    }
  } else {
    if(substr(directory, 1, 1) == '\"') {
      directory = substr(directory, 2, nchar(directory)-1)
    }
    if(!is.na(directory) && file.info(directory)$isdir == TRUE) {
      dl@directory = directory
    } else {
      while(file.info(directory)$isdir == FALSE) {
        directory <- readline("That doesn't appear to be a directory, please
                              try again. > ")
      }
    }
  }
  indexAnswer <- readline("Do you have an index file? [yes/no] > ")
  
  if (indexAnswer %in% c("yes", "Yes", "YES", "y", "Y") == T) {
    indexFile <- readline("Please enter the full path to the file (usually .csv) of your index (including the file name). > ")
    if(substr(indexFile, 1, 1) == '\"') {
      indexFile = substr(indexFile, 2, nchar(indexFile)-1)
    }
    if (file.exists(indexFile) == T) { 
      dl@indexFile = indexFile
    } else {
      browser()
      stop("Index file not found. Usually this means there was a typo in your file path. Try using tab-complete to navigate your file system while entering paths.")
    }
  } 
  
  if (indexAnswer %in% c("no", "No", "NO", "n", "N") == T) {
      indexFile <- readline("Ok, we'll create one for you.  Where would you like it stored? > ")
      #browser()
      if(substr(indexFile, 1, 1) == '\"') {
        indexFile = substr(indexFile, 2, nchar(indexFile)-1)
      }
      if(!is.na(indexFile) && file.info(indexFile)$isdir == TRUE) {
        if(substr(indexFile, nchar(indexFile)-1,nchar(indexFile)-1) != "/") {
          indexFile = paste(indexFile, "/", sep="")
        }
        indexFileTemp = indexFile
        dl@indexFile = buildIndex(directory)
        if (directory != indexFile) {
          file.rename(from=paste(directory, "index.csv", sep=""), to=paste(indexFileTemp, "index.csv", sep=""))
          indexFile = paste(indexFileTemp, "index.csv", sep="")
          dl@indexFile = indexFile
        }
      } else {
        stop("The path you entered doesn't seem valid. Either you haven't created the folder, or there's a typo in the path.")
      }
  }
  
  dl@index = read.csv(dl@indexFile)
  
  stopwordsAnswer <- readline("Do you have a stopwords file? [yes/no] > ")
  if(stopwordsAnswer %in% c("yes", "Yes", "YES", "y", "Y") == T) {
    stopwordsFile = readline("Please enter the directory where your stopwords file is stored. [full path] > ")
    if(substr(stopwordsFile, 1, 1) == '\"') {
      stopwordsFile = substr(stopwordsFile, 2, nchar(stopwordsFile)-1)
    }
    if(!is.na(stopwordsFile) && file.info(stopwordsFile)$isdir == TRUE) {
      if(substr(stopwordsFile, nchar(stopwordsFile)-1,nchar(stopwordsFile)-1) != "/") {
        stopwordsFile = paste(stopwordsFile, "/", sep="")
      }
      dl@stopwordsFile = stopwordsFile
      dl@stopwords = setStopwords(stopwordsFile)
    }
  } else if(stopwordsAnswer %in% c("no", "No", "NO", "n", "N") == T) {
    print("Ok, we'll supply one for you.")
    #need to look into integrating this data.
  }
  dl@filenames = findFilenames(dl = dl, directory = directory)
  dl@paths = paste(dl@directory,"/",dl@filenames,sep="")
  return(dl)
}