Package ‘htmltools’
March21,2016
Type Package
Title ToolsforHTML
Version 0.3.5
Date 2016-03-19
Author RStudio,Inc.
Maintainer JoeCheng<joe@rstudio.com>
Description ToolsforHTMLgenerationandoutput.
Depends R(>=2.14.1)
Imports utils,digest,Rcpp
Suggests markdown,testthat
Enhances knitr
License GPL(>=2)
URL https://github.com/rstudio/htmltools
BugReports https://github.com/rstudio/htmltools/issues
RoxygenNote 5.0.1
LinkingTo Rcpp
NeedsCompilation yes
Repository CRAN
Date/Publication 2016-03-2123:36:11
Rtopicsdocumented:
as.tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
browsable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
copyDependencyToDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
css . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
findDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
HTML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1
Pdf reader thumbnails - SDK software service:C# PDF Thumbnail Create SDK: Draw thumbnail images for PDF in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Support Thumbnail Generation with Various Options for Quick PDF Navigation
www.rasteredge.com
Pdf reader thumbnails - SDK software service:VB.NET PDF Thumbnail Create SDK: Draw thumbnail images for PDF in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Support Thumbnail Generation with Various Options for Quick PDF Navigation
www.rasteredge.com
2
as.tags
htmlDependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
htmlDependency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
htmlEscape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
htmlPreserve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
htmlTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
html_print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
include. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
knitr_methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
makeDependencyRelative. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
print.shiny.tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
renderDependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
renderDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
renderTags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
resolveDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
save_html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
singleton. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
singleton_tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
subtractDependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
suppressDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
urlEncodePath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
validateCssUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
withTags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Index
25
as.tags
Convertavaluetotags
Description
AnS3methodforconvertingarbitraryvaluestoavaluethatcanbeusedasthechildofatagor
tagList.Thedefaultimplementationsimplycallsas.character.
Usage
as.tags(x, ...)
Arguments
x
Objecttobeconverted.
...
Anyadditionalparameters.
SDK software service:C# HTML5 PDF Viewer SDK to view PDF document online in C#.NET
XImage.Barcode Reader. XImage.Barcode Generator. File: Compress PDF. Page: Create Thumbnails. Page: Insert PDF Pages. Page: Delete Existing PDF Pages.
www.rasteredge.com
SDK software service:VB.NET PDF- View PDF Online with VB.NET HTML5 PDF Viewer
XImage.Barcode Reader. XImage.Barcode Generator. File: Compress PDF. Page: Create Thumbnails. Page: Insert PDF Pages. Page: Delete Existing PDF Pages.
www.rasteredge.com
browsable
3
browsable
MakeanHTMLobjectbrowsable
Description
Bydefault,HTMLobjectsdisplaytheirHTMLmarkupattheconsolewhenprinted. browsable
canbeusedtomakespecificobjectsrenderasHTMLbydefaultwhenprintedattheconsole.
Usage
browsable(x, value = TRUE)
is.browsable(x)
Arguments
x
Theobjecttomakebrowsableornot.
value
Whethertheobjectshouldbeconsideredbrowsable.
Details
YoucanoverridethedefaultbrowsabilityofanHTMLobjectbyexplicitlypassingbrowse = TRUE
(orFALSE)totheprintfunction.
Value
browsablereturnsxwithanextraattributetoindicatethatthevalueisbrowsable.
is.browsablereturnsTRUEifthevalueisbrowsable,orFALSEifnot.
builder
HTMLBuilderFunctions
Description
SimplefunctionsforconstructingHTMLdocuments.
Usage
tags
p(...)
h1(...)
h2(...)
SDK software service:VB.NET PDF File Compress Library: Compress reduce PDF size in vb.
Reduce image resources: Since images are usually or large size, images size reducing can help to reduce PDF file size effectively. Embedded page thumbnails.
www.rasteredge.com
SDK software service:C# PDF Convert to Jpeg SDK: Convert PDF to JPEG images in C#.net
Support of converting from any single one PDF page and multiple pages. Thumbnails can be created from PDF pages. Support for customizing image size.
www.rasteredge.com
4
builder
h3(...)
h4(...)
h5(...)
h6(...)
a(...)
br(...)
div(...)
span(...)
pre(...)
code(...)
img(...)
strong(...)
em(...)
hr(...)
Arguments
...
Attributesandchildrenoftheelement. Namedargumentsbecomeattributes,
andpositional arguments become children. Validchildrenaretags, single-
charactercharactervectors(whichbecometextnodes),rawHTML(seeHTML),
andhtml_dependencyobjects. Youcanalsopassliststhatcontaintags,text
nodes,orHTML.
Details
ThetagsenvironmentcontainsconveniencefunctionsforallvalidHTML5tags. Togeneratetags
thatarenotpartoftheHTML5specification,youcanusethetag()function.
DedicatedfunctionsareavailableforthemostcommonHTMLtagsthatdonotconflictwithcom-
monRfunctions.
Theresultfromthesefunctionsisatagobject,whichcanbeconvertedusingas.character().
Examples
doc <- tags$html(
tags$head(
SDK software service:C# PDF File Compress Library: Compress reduce PDF size in C#.net
Reduce image resources: Since images are usually or large size, images size reducing can help to reduce PDF file size effectively. Embedded page thumbnails.
www.rasteredge.com
SDK software service:VB.NET PDF - View PDF with WPF PDF Viewer for VB.NET
XImage.Barcode Reader. XImage.Barcode Generator. File: Compress PDF. Page: Create Thumbnails. Page: Insert PDF Pages. Page: Delete Existing PDF Pages.
www.rasteredge.com
copyDependencyToDir
5
tags$title(My first page)
),
tags$body(
h1(My first heading),
p(My first paragraph, with some ,
strong(bold),
 text.),
div(id=myDiv, class=simpleDiv,
Hereis a div with some attributes.)
)
)
cat(as.character(doc))
copyDependencyToDir
CopyanHTMLdependencytoadirectory
Description
CopiesanHTMLdependencytoasubdirectoryofthegivendirectory.Thesubdirectorynamewill
bename-version(forexample,"outputDir/jquery-1.11.0").Youmaysetoptions(htmltools.dir.version=
FALSE)tosuppresstheversionnumberinthesubdirectoryname.
Usage
copyDependencyToDir(dependency, outputDir, mustWork = TRUE)
Arguments
dependency
AsingleHTMLdependencyobject.
outputDir
Thedirectoryinwhichasubdirectoryshouldbecreatedforthisdependency.
mustWork
IfTRUEanddependencydoesnotpointtoadirectoryondisk(butratheraURL
location),anerrorisraised. IfFALSEthennon-diskdependenciesarereturned
withoutmodification.
Details
Inorderfordisk-baseddependenciestoworkwithstaticHTMLfiles,it’sgenerallynecessaryto
copythemtoeitherthedirectoryofthereferencingHTMLfile,ortoasubdirectoryofthatdirectory.
Thisfunctionmakesiteasiertoperformthatcopy.
Value
Thedependencywithitssrcvalueupdatedtothenewlocation’sabsolutepath.
SeeAlso
makeDependencyRelativecanbeusedwiththereturnedvaluetomakethepathrelativetoaspe-
cificdirectory.
SDK software service:C# PDF Convert to Images SDK: Convert PDF to png, gif images in C#
Converter control easy to create thumbnails from PDF pages. Selection for compressing to multiple image formats. Cut and paste any areas in PDF pages to images.
www.rasteredge.com
SDK software service:C# WPF PDF Viewer SDK to view PDF document in C#.NET
XImage.Barcode Reader. XImage.Barcode Generator. File: Compress PDF. Page: Create Thumbnails. Page: Insert PDF Pages. Page: Delete Existing PDF Pages.
www.rasteredge.com
6
css
css
CSSstringhelper
Description
ConveniencefunctionforbuildingCSSstyledeclarations(i.e. thestringthatgoes intoastyle
attribute,orthepartsthatgoinsidecurlybracesinafullstylesheet).
Usage
css(..., collapse_ = "")
Arguments
...
Namedstyleproperties,wherethenameisthepropertynameandtheargument
isthepropertyvalue.SeeDetailsforconversionrules.
collapse_
(Notethattheparameternamehasatrailingunderscorecharacter.) Character
tousetocollapsepropertiesintoasinglestring;likely""(thedefault)forstyle
attributes,andeither"\n"orNULLforstyleblocks.
Details
CSSuses-(minus)asaseparatorcharacterinpropertynames,butthisisaninconvenientchar-
actertouseinanRfunctionargumentname.Instead,youcanuse.(period)and/or_(under-
score)asseparatorcharacters.Forexample,css(font.size="12px")yields"font-size:12px;".
Tomarkapropertyas!important,adda! charactertotheendofthepropertyname. (Since
!isnotnormallyacharacterthatcanbeusedinanidentifierinR,you’llneedtoputthenamein
doublequotesorbackticks.)
Argumentvalueswillbeconvertedtostringsusingpaste(collapse = " ").Anypropertywitha
valueofNULLor""(afterpaste)willbedropped.
Examples
padding <- 6
css(
font.family= "Helvetica, sans-serif",
margin = paste0(c(10, 20, 10, 20), "px"),
"padding!" =if (!is.null(padding)) padding
)
findDependencies
7
findDependencies
CollectattacheddependenciesfromHTMLtagobject
Description
Walksahierarchyoftagslookingforattacheddependencies.
Usage
findDependencies(tags)
Arguments
tags
Atag-likeobjecttosearchfordependencies.
Value
AlistofhtmlDependencyobjects.
HTML
MarkCharactersasHTML
Description
MarksthegiventextasHTML,whichmeansthetag functionswillknownottoperformHTML
escapingonit.
Usage
HTML(text, ...)
Arguments
text
ThetextvaluetomarkwithHTML
...
Anyadditionalvaluestobeconvertedtocharacterandconcatenatedtogether
Value
Thesamevalue,butmarkedasHTML.
Examples
el <- div(HTML("I like <u>turtles</u>"))
cat(as.character(el))
8
htmlDependencies
htmlDependencies
HTMLdependencymetadata
Description
GetsorsetstheHTMLdependenciesassociatedwithanobject(suchasatag).
Usage
htmlDependencies(x)
htmlDependencies(x) <- value
attachDependencies(x, value, append = FALSE)
Arguments
x
Anobjectwhichhas(orshouldhave)HTMLdependencies.
value
AnHTMLdependency,oralistofHTMLdependencies.
append
IfFALSE(thedefault),replaceanyexistingdependencies. IfTRUE,addthe
newdependenciestotheexistingones.
Details
attachDependenciesprovidesanalternatesyntaxforsettingdependencies.Itissimilartolocal({htmlDependencies(x)<-value;
x}),exceptthatifthereareanyexistingdependencies,attachDependencieswilladdtothem,in-
steadofreplacingthem.
Asofhtmltools0.3.4,HTMLdependenciescanbeattachedwithoutusingattachDependencies.
Instead,theycanbeaddedinline,likeachildobjectofatagortagList.
Examples
# Create a JavaScript dependency
dep <- htmlDependency("jqueryui", "1.11.4", c(href="shared/jqueryui"),
script = "jquery-ui.min.js")
# A CSS dependency
htmlDependency(
"font-awesome", "4.5.0", c(href="shared/font-awesome"),
stylesheet ="css/font-awesome.min.css"
)
# A few different ways to add the dependency to tag objects:
# Inline as achild of the div()
div("Code here", dep)
# Inline in atagList
tagList(div("Code here"), dep)
# With attachDependencies
htmlDependency
9
attachDependencies(div("Code here"), dep)
htmlDependency
DefineanHTMLdependency
Description
DefineanHTMLdependency(i.e. CSSand/orJavaScriptbundledinadirectory). HTMLdepen-
denciesmakeitpossibletouselibrarieslikejQuery,Bootstrap,andd3inamorecomposableand
portablewaythansimplyusingscript,link,andstyletags.
Usage
htmlDependency(name, version, src, meta = NULL, script = NULL,
stylesheet = NULL, head = NULL, attachment = NULL, all_files = TRUE)
Arguments
name
Libraryname
version
Libraryversion
src
Unnamedsingle-elementcharactervectorindicatingthefullpathofthelibrary
directory. Alternatively,anamedcharacterstringwithoneormoreelements,
indicatingdifferentplacestofindthelibrary;seeDetails.
meta
Namedlistofmetatagstoinsertintodocumenthead
script
Script(s)toincludewithinthedocumenthead(shouldbespecifiedrelativetothe
srcparameter).
stylesheet
Stylesheet(s)toincludewithinthedocument(shouldbespecifiedrelativetothe
srcparameter).
head
ArbitrarylinesofHTMLtoinsertintothedocumenthead
attachment
Attachment(s)toincludewithinthedocumenthead.SeeDetails.
all_files
Whetherallfilesunderthesrcdirectoryaredependencyfiles. IfFALSE,only
thefilesspecifiedinscript,stylesheet,andattachmentaretreatedasde-
pendencyfiles.
Details
Eachdependencycanbelocatedonthefilesystem,atarelativeorabsoluteURL,orboth. The
locationtypesareindicatedusingthenamesofthesrccharactervector: fileforfilesystemdi-
rectory,hrefforURL.Forexample,adependencythatwasbothondiskandataURLmightuse
src = c(file=filepath, href=url).
attachmentcanbeusedtomaketheindicatedfilesavailabletotheJavaScriptonthepageviaURL.
Foreachelementofattachment,anelement<linkid="DEPNAME-ATTACHINDEX-attachment"rel="attachment"
href="...">isinserted,whereDEPNAMEisname.ThevalueofATTACHINDEXdependsonwhether
attachmentisnamedornot;ifso,thenit’sthenameoftheelement,andifnot,it’sthe1-basedindex
10
htmlEscape
oftheelement.JavaScriptcanretrievetheURLusingsomethinglikedocument.getElementById(depname+"-"+index+"-attachment").href.
Notethatdependingontherenderingcontext,theruntimevalueofthehrefmaybeanabsolute,rel-
ative,ordataURI.
htmlDependencyshouldnotbecalledfromthetop-levelofapackagenamespacewithabsolute
paths(orwithpathsgeneratedbysystem.file())andhavetheresultstoredinavariable.Thisis
because,whenabinarypackageisbuilt,RwillrunhtmlDependencyandstorethepathfromthe
buildingmachine’sinthepackage. Thispathislikelytodifferfromthecorrectpathonamachine
thatdownloadsandinstallsthebinarypackage. Ifthereareanyabsolutepaths,insteadofcalling
htmlDependencyatbuild-time,itshouldbecalledatrun-time. Thiscanbedonebywrappingthe
htmlDependencycallinafunction.
Value
AnobjectthatcanbeincludedinalistofdependenciespassedtoattachDependencies.
SeeAlso
UseattachDependenciestoassociatealistofdependencieswiththeHTMLitbelongswith.
htmlEscape
EscapeHTMLentities
Description
EscapeHTMLentitiescontainedinacharactervectorsothatitcanbesafelyincludedastextoran
attributevaluewithinanHTMLdocument
Usage
htmlEscape(text, attribute = FALSE)
Arguments
text
Texttoescape
attribute
Escapeforuseasanattributevalue
Value
Charactervectorwithescapedtext.
Documents you may be interested
Documents you may be interested