del.hdoc 

 

Package or File:  jmfuns.rda

 

del.hdoc takes a path + file name as argument and deletes the html documentation for the document; the html documentation is stored in \aaaTravel\doc.nts and in a subdirectory.

 

The html doc files in \AAATravel\doc.nts have the form:

      study.q's.ch12-13.nts$^p355^goldstein^.htm

where study.q's.ch12-13 represents the file (without extension), and $^p355^goldstein^ represents the path to this file, \p355\goldstein\.  A subdirectory corresponding to this file, \AAATravel\doc.nts\study.q's.ch12-13.nts$^p355^goldstein^_files\, contains the auxilliary files for the htm file.  The R command:

del.hdoc( "/p355/goldstein/study.q's.ch12-13.docm")

uses R to delete both the documentation file:

      study.q's.ch12-13.nts$^p355^goldstein^.htm

and the auxilliary subdirectory:

      \AAATravel\doc.nts\study.q's.ch12-13.nts$^p355^goldstein^_files\

del.hdoc also applies to a vector for path + file names, e.g.,

      del.hdoc( c(

     "/p355/goldstein/study.q's.ch12-13.docm",

     "/cm/tmcmptrs.docm",

     "/adroid/htm/tempinfo.htm"

     ) )

Note that every path starts with / and ands in a file name. 

 

ARGUMENTS

x is a vector of strings.  Each string is a path + file name for a file whose documentation is to be deleted from \AAATravel\doc.nts. 

 

show.failure = TRUE (default) if a dataframe of file names is outputted where the deletion operation failed.  The dataframe includes information about the cause the failure. 

 

show.all = FALSE (default) if full output for all deletions is not to be written to the monitor. 

 

------------------------

Format for this html document:

    Page Size = Tabloid:  11" x 17".  Note that Tabloid page size is available if Adobe PDF is set as the default printer, but not if the default pringer is a physical printer that prints 8.5" x 11" standard paper. 

    Table widths = 9.5"