csmIndexer: CSM Indexer
In csmoxford/csmIndexer: CSM file indexer

Description Usage Arguments Details Author(s) Examples

A small indexer which produces a pdf of the contents of a folder.

1	csmIndexer()

`path`	The path to the folder to be indexed
`pageLogo`	The path to logos to add at the top of each page
`titleLogo`	The path to logos to add on the title page
`author`	The author of the document
`title`	The document title
`personnel`	The key personnel working on the documents contained in the folder. You may wish to include start and end dates here if appropriate.
`headerLogoWidth`	The width to display the logo on the indexer page in cm. Default is 1.5

Prerequesites: You must have installed miktex and it must be available on the PATH.

Please set the working directory explicitely using setwd() to ensure you know where the file is being created.

Note that the R programming language uses bachslash \ to create special characters. The simplest way to write paths is to replace them with forwardslash /.

Eleni Frangou

Peter Dutton

#################################################################
# Note that the example has been designed to run on the I: drive
# at CSM and so will not work if you do not have access to this drive.
#################################################################

# install package containing the indexer.
install.packages("devtools")
devtools::install_github("csmoxford/csmIndexer")

# Load the library containing the functions
library(csmIndexer)

#################################################################
# Note that the R programming language uses bachslash \ to create special
# characters. The simplest way to write paths is to replace them with
# forwardslash /.
#################################################################

# Tell R where to create the pdf file.
setwd("I:/Data/Useful Programs/Statistical TMF Index")

# The path to the folder to be indexed.
path <- "I:/Data/Useful Programs/Statistical TMF Index"
# The path to logos to add at the top of each page. Multi logos possible.
pageLogo <- c("I:/Data/OCTRU_SOPs/CSMLogo.png")
# The path to logos to add on the title page. Multi logos possible.
titleLogo <- c("I:/Data/OCTRU_SOPs/CSMLogo.png")
# The author of the document.
author <- "Eleni Franou"
# The document title.
title <- "Index of useful Programs Folder"
# The key personnel working on the documents contained in the folder.
# You may wish to include start and end dates here if appropriate.
personnel <- c("Peter Dutton (Statistician)", "Eleni Frangou (Statistician)")

# Create the pdf
csmIndexer()