teldiR was specifically designed to help process unstructured text into tables of information that are easily analysed. It had been primarily designed to process the archive of historical telephone directory scans from British Telecommunications; the functions contained therein were used mainly on a series of .txt text files that were the outputs of Optical Character Recognition (OCR) done prior. With some customisation, it could potentially be applied to datasets, either historical and/or less structured, other than these scans of telephone directories.
There are two options for installing the teldiR package to your local installation of R.
teldiR is not distributed through CRAN, so you will have to install it directly from Github using the devtools package in R. If you do not have devtools installed, you will have to run the first line in the code below as well.
# install.packages('devtools') #if not already installed
devtools::install_github('kinatou/teldiR')
If the above steps do not work, the alternative is to do a local installation.
- Download the files of the entire repository, placing them in a master folder anywhere on your computer and calling this folder 'teldiR'
- In R, install
teldiRfrom your local directory with the code shown below.
# install.packages('devtools') #if not already installed
devtools::install("file-path/to-folder-of/teldiR")
The R package installation has documentation built-in. For every function contained in teldiR, you may type ?name_of_function in the console to pull out its corresponding documentation and description of how to use it.
Many functions in teldiR are equipped with default settings that reference a specific folder structure. Many of these file path references can be changed by specifying certain arguments, but should it be deemed more convenient, the relevant folder structure can be seen in the BTPhoneDirectories repository.