Man pages for Nozzle.R1
Nozzle Reports
| addTo | Add child elements to a parent element. |
| addToInput | Add elements to the "Input" subsection in the "Methods &... |
| addToIntroduction | Add elements to the "Introduction" subsection in the... |
| addToMeta | Add elements to the "Meta" section of a standard report. |
| addToMethods | Add elements to the "Methds & Data" section of a standard... |
| addToOverview | Add elements to the "Overview" section of a standard report. |
| addToReferences | Add elements to the "References" subsection in the "Methods &... |
| addToResults | Add elements to the "Results" section of a standard report. |
| addToSummary | Add elements to the "Summary" subsection in the "Overview"... |
| asCode | Format text as code. |
| asEmph | Format text with emphasis (usually resulting in text set in... |
| asFilename | Format text as filename. |
| asLink | Format text as a hyperlink. |
| asParameter | Format text as parameter. |
| asReference | Reference a citation, figure or table element. |
| asStrong | Format text with strong emphasis (usually resulting in text... |
| asSummary | Include a result in text. This is a legacy method and... |
| asValue | Format text as value. |
| DEFAULT.DOI.RESOLVER | Default DOI resolver URL. |
| DEFAULT.REPORT.FILENAME | Default filename for reports. |
| DEFAULT.SIGNIFICANT.ENTITY | Name of entities that are labeled as signficiant. |
| getContactInformationEmail | Get contact email address for 'report'. |
| getContactInformationLabel | Get label for contact button for 'report'. |
| getContactInformationMessage | Get contact email default message for 'report'. |
| getContactInformationSubject | Get contact email subject line for 'report'. |
| getCopyrightOwner | Get name of the copyright owner for 'report'. |
| getCopyrightStatement | Get copyright statement for 'report'. This text is linked to... |
| getCopyrightUrl | Get copyright URL for 'report', which is linked to the... |
| getCopyrightYear | Get copyright year 'report'. |
| getCreatorDate | Get date when 'report' was created. |
| getCreatorName | Get name and version of the Nozzle package that was used to... |
| getCustomPrintCss | Get the path or URL of the CSS file to be used to overwrite... |
| getCustomScreenCss | Get the path or URL of the CSS file to be used to overwrite... |
| getDoi | Get the DOI (document object identifier, http://www.doi.org)... |
| getDoiCreator | Get the DOI creator for 'report'. |
| getDoiPublisher | Get the DOI publisher for 'report'. |
| getDoiResolver | Get the DOI resolver URL (e.g. http://dx.doi.org) for... |
| getDoiTitle | Get the DOI title for 'report'. |
| getDoiVersion | Get the DOI version for 'report'. |
| getDoiYear | Get the DOI year for 'report'. |
| getExportedElement | Get an exported element from a report. This can be used to... |
| getExportedElementIds | Get the IDs of exported elements from 'report'. This is an... |
| getFigureFile | Get path or URL of image file associated with a figure... |
| getFigureFileHighRes | Get path or URL of high-resolution of vector-based image file... |
| getGoogleAnalyticsId | Get Google Analytics tracking ID for 'report'. |
| getLogo | Get logo file for one of six positions (three at the top,... |
| getMaintainerAffiliation | Get affiliation of maintainer of 'report'. |
| getMaintainerEmail | Get email address of maintainer of 'report'. |
| getMaintainerName | Get name of maintainer of 'report'. |
| getRendererDate | Get date when 'report' was rendered. |
| getRendererName | Get name and version of the Nozzle package that was used to... |
| getReportId | Get the ID (a UUID) of 'report'. |
| getReportSubtitle | Get the subtitle of 'report'. |
| getReportTitle | Get the title of 'report'. |
| getSignificantEntity | Get name of entities that are called out as significant, e.g.... |
| getSignificantResultsCount | Get the total number of significant results in 'report'. |
| getSoftwareName | Get the name of the software that used Nozzle to generate... |
| getSoftwareVersion | Get the version of the software that used Nozzle to generate... |
| getSummary | Get the first element of the "Summary" subsection in the... |
| getTableFile | Get path or URL of file associatd with table element. |
| HTML.FRAGMENT | Output type. |
| HTML.REPORT | Output type. |
| IMAGE.TYPE.PDF | Image type. |
| IMAGE.TYPE.RASTER | Image type. |
| IMAGE.TYPE.SVG | Image type. |
| isFigure | Test if 'element' is a figure element. |
| isTable | Test if 'element' is a table element. |
| LOGO.BOTTOM.CENTER | Logo position. |
| LOGO.BOTTOM.LEFT | Logo position. |
| LOGO.BOTTOM.RIGHT | Logo position. |
| LOGO.TOP.CENTER | Logo position. |
| LOGO.TOP.LEFT | Logo position. |
| LOGO.TOP.RIGHT | Logo position. |
| newCitation | Create a citation element. |
| newCustomReport | Create a new custom report without pre-defined sections. |
| newFigure | Create a new list element. |
| newHtml | Create a new freeform HTML element. THIS MUST BE USED WITH... |
| newJournalCitation | Create a citation element that represents a document... |
| newList | Create a new list element. |
| newParagraph | Create a new paragraph element. |
| newParameterList | Create a new parameter list element. A parameter list is an... |
| newReport | Create a new report with pre-defined sections... |
| newResult | Create a new result element. |
| newSection | Create a new section element. |
| newSubSection | Create a new subsection element. |
| newSubSubSection | Create a new subsubsection element. |
| newTable | Create new table element. |
| newWebCitation | Create a citation element that represents a document... |
| Nozzle.R1-package | Nozzle: a Report Generation Toolkit for Data Analysis... |
| PROTECTION.GROUP | Group visibility. |
| PROTECTION.PRIVATE | Private visibility. |
| PROTECTION.PUBLIC | Public visibility. |
| PROTECTION.TCGA | Group visibility. |
| RDATA.REPORT | Output type. |
| SECTION.CLASS.META | Section class. |
| SECTION.CLASS.RESULTS | Section class. |
| setContactInformation | Set contact information for 'report'. This is used to create... |
| setCopyright | Set copyright messsage for 'report'. |
| setCustomPrintCss | Set the path or URL of the CSS file to be used to overwrite... |
| setCustomScreenCss | Set the path or URL of the CSS file to be used to overwrite... |
| setDoi | Set the DOI (document object identifier, http://www.doi.org)... |
| setDoiCreator | Set the DOI meta data creator for 'report'. |
| setDoiPublisher | Set the DOI meta data publisher for 'report'. |
| setDoiResolver | Set the DOI resolver URL (e.g. http://dx.doi.org) for... |
| setDoiTitle | Set the DOI meta data title for 'report'. |
| setDoiVersion | Set the DOI meta data version for 'report'. |
| setDoiYear | Set the DOI meta data year for 'report'. |
| setFigureFile | Set path or URL of image file associated with a figure... |
| setFigureFileHighRes | Set path or URL of high-resolution or vector-based image file... |
| setGoogleAnalyticsId | Set the Google Analytics tracking ID to be embedded in this... |
| setLogo | Set a logo file for one of six positions (three at the top,... |
| setMaintainerAffiliation | Set affiliation of maintainer of 'report'. |
| setMaintainerEmail | Set email address of maintainer of 'report'. |
| setMaintainerName | Set name of maintainer of 'report'. |
| setNextReport | Set the URL and title of the "next" report after 'report'.... |
| setParentReport | Set the URL and title of the "parent" report above 'report'.... |
| setPreviousReport | Set the URL and title of the "previous" report before... |
| setReportSubtitle | Set the subtitle of 'report'. |
| setReportTitle | Set the title of 'report'. |
| setSignificantEntity | Set name of entities that are called out as significant, e.g.... |
| setSoftwareName | Set the name of the software that used Nozzle to generate... |
| setSoftwareVersion | Set the name of the software that used Nozzle to generate... |
| setTableFile | Set path or URL of file associatd with table element. |
| TABLE.SIGNIFICANT.DIGITS | Default number of significant digits to be used to trim... |
| writeReport | Write 'report' to file. |
