title = 'TitleFieldID' so that another field can me mapped to title. Unless you pass the additional optional title argument, e.g. So this field is always available even if not part of the file metadata.Īdditionally, if there is no title field in the metadata, the output data frame will include a title column filled in with the same file names, Note that when 'file' is included in fields, the output will include a column of the original file names, in case this is different from the content of a source field that may be present in the metadata.

This is not possible for large collections with possibly different formatting. Ideally, you should already know what metadata fields are in the EPUB file. Some fields will be returned even if not in fields, such as data and title. The fields argument can be used to limit the columns returned in the primary data frame.Į.g., fields = c('title', 'creator', 'date', 'identifier', 'publisher', 'file'). They are most likely to be useful for bulk e-book processing where file is a vector of like-formatted files. You can ignore these arguments and do all your own post-processing of the resulting data frame, but if using these arguments, However, the optional arguments fields, drop_sections and chapter_pattern allow you to do some of this as part of the EPUB file reading process. On a case by case basis, you can always select columns and filter rows of a resulting data frame for a single e-book subsequent to visual inspection. This could take a long time to process as well as could potentially use up all of your system RAM if you have far too many large books in one call to epub. It has metadata in all columns except the data column, which is a column of nested data frames containing e-book text by book section (e.g., chapters).īoth the primary and nested data frames are tibbles and safe to print to the console 'as is'.īe careful if file is a long vector of many EPUB files. The output data frame has one row for each file in file. It parses EPUB file metadata and textual content into a data frame.

Read epub