PDE is a R package that easily extracts information and tables from PDF files. The
PDE_analyzer_i() performs the sentence and table extraction while the included
PDE_reader_i() allows the user-friendly visualization and quick-processing of the obtained results.
Install the dependent packages
install.packages("tcltk2") # Install the dependent package tcltk2
The package requires the Xpdf command line tools by Glyph & Cog, LLC. Please download and install the Xpdf command line tools 4.2 from the following website onto your local disk: https://github.com/erikstricker/PDE/tree/master/inst/examples/bin (https://github.com/erikstricker/PDE/tree/master/inst/examples/bin). Alternatively, the following command can be used to install the correct Xpdf command line tools:
PDE_install_Xpdftools4.02() # Download and install the Xpdf command line tools PDE_check_Xpdf_install() # Check if all required XPDF tools are installed correctly
Install the package through CRAN
install.packages("PDE", dependencies = TRUE)
or choose the location where you downloaded latest PDE_*.*.*.tar.gz and install it from a local path.
filename <- file.choose() # Choose the location where you downloaded the latest PDE_*.*.*.tar.gz install.packages(filename, type="source", repos=NULL)
NOTE: The PDE package was tested on Microsoft Windows, Mac and Linux machines. Major differences include the visual appearance of the interfaces and the directory structures, but all functions are preserved.
The PDE analyzer can be accessed through different functions which are outlined below.
PDE_analyzer() PDE_analyzer_i() PDE_extr_data_from_pdfs() PDE_pdfs2table() PDE_pdfs2table_searchandfilter() PDE_pdfs2txt_searchandfilter()
The PDE reader is only available as an interactive user interface requiring the R package tcltk2.
NOTE: For problem solution concerning a potential error when starting
PDE_reader_i() on Mac see Troubleshoot - Error when starting interactive user interface on Mac (failed to allocate tcl font).
PDE_analyzer_i()user interface on Linux
PDE_reader_i()user interface on Mac
This should open a user interface.
Load either a sentence analysis file or a folder with such files.
NOTE: Analysis files refer to the files created by the PDE_analyzer_i() which contain “txt+-” in their name.
The user can browse through all analysis files in the folder to get an overview over the data.
Additional functions can be enabled by loading the PDF folder as well as the TSV file used for analysis.
NOTE: Flagging and marking changes filenames but can be reversed in the program at any time.
NOTE: Arguments for the R function
PDE_extr_data_from_pdfs() are listed below each description:
PDE_analyzer_i()user interface - Choose the locations for the required files
Load form from tsv OR Save form as tsv: The filled form can and should be saved as a TSV file at any time, accordingly the saved parameters can be loaded from saved TSV files.
Reset form: This will clear all fields and variables.
PDE_analyzer_i()user interface - Input/Output
Open PDF folder: Open a folder with PDF files you want to analyze. For the analysis, all PDF files in the folder and subfolders will be analyzed.
Load PDF files: Select one or more PDF files you want to analyze (use Ctrl and/or Shift to select multiple). Multiple PDF files will be separated by ; without a space.
Open output folder: All analysis files will be created inside of this folder; therefore, choose an empty folder or create a new one as output directory, since analyses create at least a number of files equal to the amount of PDF files analyzed. If no output folder is chosen, the results will be saved in the R working directory.
Choose output format: The resulting analyses files can either be generated as comma-separated values files (.csv) or tab-separated values files (.tsv), with the former being easier to open and save in Microsoft Excel, while the later leads to less errors when opening in Microsoft Excel (as tabs are rare in texts). Depending on the operational system the output file are opened in, it is recommended to choose the Microsoft Windows (WINDOWS-1252), Mac (macintosh) or Linux (UTF-8) encoding.
PDE_analyzer_i()user interface - Search Words
Choose what to extract: The PDE analyzer has 2 main functions A] PDF2TXT (extract sentences from pdf) and B] PDF2TABLE (table of PDF to excel file) which can be combined or executed separately. Each function can be combined with filters and search words. A file with the sentences carrying the search words will have the name format:
[search words]txt+-[context][PDF file name] in the corresponding subfolder. Tables will be named:
[PDF file name][number of table][table heading].
Search words?: The algorithm can either extract , tables, or sentences and tables with one of the search words present. If the “tables” only analysis was chosen, the algorithm can also extract all tables detected in the paper (choose this option here). In the later case, the search words field should remain empty.
Search words: Type in the list of search words separated by “;” without spaces in between.
Search words case sensitive: E.g., for “Word”, if “no” was chosen then “word”, “WORD”, “Word”, etc., will be detected, if “yes” was chosen only “Word” will be detected.
Number of sentences before and after: When 0 is chosen, only the sentence with the search word is extracted. If any number n is chosen, n number of sentences before and n number of sentences after the sentence with the search word will be extracted. A sentence is currently defined by starting and ending with a “.” (period with a subsequent space).
Evaluate abbreviations?: If “yes” was chosen, all abbreviations that were used in the PDF documents for the search words will be saved and then replace by
abbreviation (search word)$*, e.g.,
MTX will be replaced by
MTX (Methotrexate)$*. In addition plural of the abbreviations, i.e., the abbreviation with an “s” at the end will be replaced accordingly as well.
PDE_analyzer_i()user interface - Filter Words
Filter words?: In some cases, only articles of a certain topic should be analyzed. Filterwords provide a way to analyze only articles which carry words from a list at least n times.
Filter words: Type in the list of filter words separated by “;” without spaces in between. A hit will be counted every time a word from the list is detected in the article.
Filter words case sensitive: E.g., for “Word”, if “no” was chosen then “word”, “WORD”, “Word”, etc., will be detected, if “yes” was chosen only “Word” will be detected.
Filter word times: This represents the minimum number of hits described above which has to be detected for a paper to be further analyzed. If the threshold is not met, a documentation file can be exported if selected in the documentation section.
PDE_analyzer_i()user interface - Parameters
Enter table headings: Standard scientific articles have their tables labeled with “TABLE”, “TAB”, “Table” or “table” plus number and are detected accordingly. If a table is expected to have a different heading, it should be typed in this field. For multiple different heading use “;” without extra spaces.
Table heading case sensitive: E.g., for “HEADING”, if “no” was chosen then “HEADING”, “heading”, “Heading”, etc., will be detected, if “yes” was chosen only “HEADING” will be detected.
Column pixel deviation: For some tables the heading is slightly indented which would make the algorithm assume it was a separated column. With the column pixel deviation the size of indention which would be considered the same column can be adjusted.
Row pixel deviation: For some tables elements even though in the same row can have slightly different vertical coordiates. With the row pixel deviation the variation of vertical coordinates which would be considered the same row can be adjusted. It can be either a number or set to dynamic detection , in which case the font size is used to detect which words are in the same row.
PDE_analyzer_i()user interface - Documentation/Debugging
Table values in file: When “tables” detection/export was chosen, this option will be relevant. For “yes”, a separate file with the headings of all tables, their relative location in the generated HTML and TXT files, as well as information if search words were found will be generated. The files will start with “htmltablelines”, “txttablelines”, “keeplayouttablelines” followed by the PDF file name and can be found in
Export tables with problems: For “yes”, if a table was detected in a PDF file but is an image or cannot be read, the page with the table with be exported as a portable network graphics (PNG) file. The documentation file will have the name format:
[PDF name]page[page number]w.table-[page number].png
Table documentation files?: For “yes”, if search words are used for table detection and no search words were found in the tables of a PDF file, a file will be created with the PDF name followed by “no.table.w.search.words” in the folder with the name
Sentence documentation file?: For “yes”, if no search words were found in the sentences of a pdf, a file will be created with the PDF file name followed by “no.txt.w.search.words” in the
no_txt_w_sw folder. If the PDF file is empty, a file will be created with the PDF file name followed by “non-readable” in the
nr folder. Files that were filtered out using the filterwords will lead to the creation of a file with the PDF name followed by “no.txt.w.filter.words” in the
Keep intermediate files: The program generates a txt, keeplayouttxt and HTML copy of the PDF file, which will be deleted if intermediate files deletion is chosen. In case, this option was chosen accidentally, the user has two options to delete the .txt and .html file. 1) Slow & easy option: Rerun the analysis with this option being yes. 2) Quick and slightly more complicated option: Open the file explorer and search for
*.html in the PDF folder. Then select all files and folders of the search result and press delete. Keeping the intermediate files will set the
FALSE. Argument for
PDE_reader_i()user interface on Microsoft Windows
PDE_reader_i()user interface - Load and open
Load either a sentence analysis file or a folder with such files. The table shown in the center of the application is writable, editable and copyable, but changes will not be saved in the original file.
NOTE: Analysis files refer to the files created by the PDE analyzer which contain “txt+-” in their name.
Open analysis file: Loading a single file will be quick and open the selected file in the reader. The file will also be added into the memory of the program until the program is closed. All other analysis files in the folder will be shown under “Jump to file:”.
Load analysis folder: This will load all analysis files into the memory. For larger number of files, the progress bar on the top right will indicate the progress and indicate when the program can be accessed again. All files will be shown under “Jump to file:” and are quickly accessible, since they are in the memory.
Save memory to file: The table and all tables that are currently displayed by the
PDE_reader_i() during a session are saved into the memory of the program, enabling quick browsing through the tables with minimal loading time. Since the memory is reset anytime the program closes, the memory can be saved into a .RData file to prevent long loading times during later sessions.
Load memory from file: Tables that were saved into the memory during earlier sessions can be loaded into the program from a corresponding .RData file.
Reset form: The form and memory can be emptied with this button.
On/off: This button enables switching between search word highlighting in case an appropriate TSV file is loaded (see Load TSV file). The button shows the current state of highlighting. The search word is found between █▶ and ◄█.
Load all: The options Load TSV file and Open analysis file will only save the already displayed tables into the memory. To shorten loading times all analysis files in the current folder as well as their search word highlighted tables can be loaded into the memory with this button. This will load the tables with and without highlighting to allow rapid switching between the two. The green bar on the top right will display the progress.
NOTE: In the case of high numbers of search words or analysis files this step can take a long time (e.g., 1500 analysis files + 400 search words -> 1.5 h). For this reason, saving the memory to a file once the files are loaded is recommended.
Load TSV file: Search words used for the analysis can be highlighted by loading the TSV parameter file used for the analysis. The highlighting can be turned off and on and search words are indicated in the table by █▶-
Load PDF folder: The analyzed PDF file can be loaded into the reader by loading the PDF folder with the corresponding files. The PDF file name will show to the left of the Open current pdf button below the load PDF folder row.
Open current pdf: If a PDF file analyzed is detected in the PDF folder, pressing the button will open the PDF file in the system default PDF viewer.
Extract tables: This button allows the user to extract all tables from the current PDF file converting them into an Excel compatible format. Extraction parameters such as pixel deviation between columns (see
PDE_analyzer_i() §3) are derived from the TSV file chosen for search word highlighting. The extraction of the tables usually takes a few seconds, and, after extraction, the destination folder (same as analysis file folder) of the extracted tables is opened.
NOTE: The table extraction only works when PDF file and TSV files are available.
Jump to file: This check box lists all analysis files in the chosen folder. When choosing a file from the list, the reader jumps to the respective table. This will happen with a slight delay if the files are not already loaded in the memory (see Open analysis file, Load analysis folder).
PDE_reader_i()user interface - Table display
Font size: The font size of all buttons, the labels and the table can be increased (+), decreased (-) or reset (o) located above the table.
hotkey mode: There are 4 different hotkey modes, which allow the use of the buttons of a keyboard to quickly navigate through files. The hotkeys for each mode are as follows and can be changed by clicking on the botton on the right of the hotkey mode label:
|standard||one hand||one hand & standard (oh+std)||no hotkey|
|previous||n or left arrow||j or a||j or a or n or left arrow||none|
|next||p or right arrow||l or d||l or d or p or right arrow||none|
|scroll table down||down arrow||k or s||k or s or down arrow||none|
|scroll table up||up arrow||i or s||i or s or up arrow||none|
|flag file||f||h or f||h or f||none|
|x mark file||x||space||space or x||none|
|unmark file||u||u or e||u or e||none|
|open pdf||o||o or q||o or q||none|
Wrap: When choosing this option, located on the right above the table, the text in the central table will have line breaks to be fully visible. This will prevent in some occasions the resizing of the window. To prevent this issue, choose “don’t wrap” while resizing and activate resizing afterwards, again. In case the table does not fit vertically inside the window, either the scroll bar can be used to show different rows of the table.
Sentence number: If sentences surrounding the sentence with the search word were extracted by the
context > 0), the number of sentences displayed can be decreased (-), increased (+), or reset (o). When changing this setting, the sentences with the search word will always be displayed.
Show txtcontent only: Generally, the analysis file includes information about the page and paragraphs where the sentences were extracted from. When selecting Show txtcontent only, only the sentences without the positional information is displayed.
Show original text (abbreviations collapsed): If the analysis abbreviations were replaced in the format ABBREVIATION -> ABBREVIATION (search word)$* (i.e., eval.abbrev = TRUE), then the original text can be restored by using this setting. This setting will also lead to the disappearance of some search words, as only the abbreviations remain.
PDE_reader_i()user interface - Browse and mark
Prev and Next: Using these buttons the user can quickly browse through the different tables in the analysis folder.
Flag file: Using this button can either Mark analysis file only, Mark PDF only or Mark analysis file & PDF. The reader will rename the corresponding file adding a “!_” to the beginning of its name.
X mark file: Using this button can either Mark analysis file only, Mark PDF only or Mark analysis file & PDF. The reader will rename the corresponding file adding a “x_” to the beginning of its name.
Unmark file: Using this button can either Unmark analysis file only, Unmark PDF only or Unmark analysis file & PDF. The reader will remove and existing “!_” or “x_” at the beginning of the file name.
NOTE: Flagging and marking changes filenames but can be reversed in the program at any time.
This section covers common errors we encountered when testing the package including their solution.
Error in structure(.External(.C_dotTclObjv, objv), class = "tclObj") : [tcl] failed to allocate font due to internal system font engine problem.
echo 'export PATH=$PATH:/path/to/pdftotext' >> ~/.bashrc
All files for example can be found in the installation folder
examples. The folder can be located by running the following code in the R console:
system.file(package = "PDE")
PDE_parameters_v1.0_all_files+-0.tsvfound in the subfolder
examples/tsvs/. Then continue with Start the PDE analyzer.
PDE_analyzer_i()user interface - Input/Output
(methotrexate) NOT Review[Publication Type]as well as 1 erroneous (
99999999_x.pdf) and 1 empty file (
00000000_x.pdf) are in the following folder:
The file names indicate the PMIDs. In addition, negative controls are marked with an “x" and the files which include tables with the search words are marked with an "!” (this naming system is specifically chosen for the example, but generally analyses files are not restricted to any particular naming system other than no two files should have the same name).
Load PDF files: Select the 5 PDF files to analyze (use Ctrl and/or Shift to select multiple).
examples/Methotrexate/29973177_!.pdf examples/Methotrexate/31083238_!.pdf examples/Methotrexate/31261533_x.pdf examples/Methotrexate/00000000_x.pdf examples/Methotrexate/99999999_x.pdf
Choose what to extract: For the example, the analyzer will extract sentences and tables with the keywords. Accordingly, the option
both should be chosen.
Open output folder: The files created by the
PDE_analyzer_i() should be identical to the files found in
examples/MTX_output. Any output folder can be chosen for the example analysis but the following folder is recommended for direct comparison: