R/notes.R

In trinker/reports: An R Package to Assist in the Workflow of Writing Academic Articles and Other Reports

#' View Notes
#' 
#' Allows a truncated view of your notes (\file{~/ARTICLES/notes}).
#' 
#' @param col.width An integer value of the maximum width of columns.
#' @param notes.col logical.  If \code{TRUE} the notes column will be displayed.
#' @return Returns a truncated view of user notes.
#' @export
#' @importFrom xlsx read.xlsx
#' @importFrom tools file_ext
#' @examples 
#' \dontrun{
#' notes()
#' }
notes <- function(col.width = 70, notes.col = FALSE) {
    mess <- paste0("\n\nPossible causes:\n\n",
    "1) The main file directory is not set as the working directory\n",
    "2) ~/ARTICLES/notes.xlsx or ~/ARTICLES/notes.csv does not exist")
    out <- tryCatch(read.notes(trunc = col.width, notes.col = notes.col, print=FALSE), 
        error=function(err) stop(mess))
    truncdf(out, col.width)
}

notes2 <- function(col.width = 70, notes.col = FALSE) {
    mess <- paste0("\n\nPossible causes:\n\n",
    "1) The main file directory is not set as the working directory\n",
    "2) ~/ARTICLES/notes.xlsx or ~/ARTICLES/notes.csv does not exist")
    out <- tryCatch(read.notes(trunc = col.width, notes.col = notes.col), 
        error=function(err) stop(mess))
    out
}