| Type: | Package |
| Title: | Two Highly Customizable 'rmarkdown' Themes for Scientific Reports |
| Version: | 2025.1 |
| Maintainer: | Obinna Obianom <idonshayo@gmail.com> |
| Description: | Offers 'markdown' output formats designed with various styles, allowing users to generate HTML reports tailored for scientific or machine learning showcase. The output has a contemporary appearance with vibrant visuals, providing numerous styles for effective highlighting. Created using the 'tufte' https://rstudio.github.io/tufte/ package code as a starting point. |
| License: | MIT + file LICENSE |
| URL: | https://scientific.obi.obianom.com |
| BugReports: | https://github.com/oobianom/scientific/issues |
| Imports: | htmltools, knitr, rmarkdown, xfun |
| Suggests: | testthat |
| Encoding: | UTF-8 |
| Config/testthat/edition: | 3 |
| VignetteBuilder: | knitr |
| Language: | en-US |
| LazyData: | false |
| RoxygenNote: | 7.2.3 |
| NeedsCompilation: | no |
| Packaged: | 2025-03-05 04:29:10 UTC; in198 |
| Author: | Obinna Obianom [aut, cre] |
| Repository: | CRAN |
| Date/Publication: | 2025-03-05 10:50:03 UTC |
scientific: Two Highly Customizable 'rmarkdown' Themes for Scientific Reports
Description
Offers 'markdown' output formats designed with various styles, allowing users to generate HTML reports tailored for scientific or machine learning showcase. The output has a contemporary appearance with vibrant visuals, providing numerous styles for effective highlighting. Created using the 'tufte' https://rstudio.github.io/tufte/ package code as a starting point.
Author(s)
Maintainer: Obinna Obianom idonshayo@gmail.com
See Also
Useful links:
Scientific handout formats (PDF and HTML)
Description
Template for creating scientific handout
Usage
newthought(text)
margin_note(text, icon = "⊕")
quote_footer(text)
sans_serif(text)
html(..., template = "template1")
Arguments
text |
A character string to be presented as a “new thought” (using small caps), or a margin note, or a footer of a quote |
icon |
A character string to indicate there is a hidden margin note when the page width is too narrow (by default it is a circled plus sign) |
... |
Other arguments to be passed to [html_document()] (note you cannot use the 'theme' argument in 'html()'; this arguments have been set internally) |
template |
template name to use |
Details
'newthought()' can be used in inline R expressions in R Markdown “'r 'r newthought(Some text)' “' and it works for both HTML (‘<span class="newthought">text</span>’) and PDF (‘\newthought{text}’) output.
'margin_note()' can be used in inline R expressions to write a margin note (like a sidenote but not numbered).
'quote_footer()' formats text as the footer of a quote. It puts 'text' in ‘<footer></footer>’ for HTML output, and after ‘\hfill’ for LaTeX output (to right-align text).
'sans_serif()' applies sans-serif fonts to 'text'.
'handout()' provides the PDF format
'html()' provides the HTML format based on the scientific CSS
Value
an HTML notebook output based on the R markdown document provided
Note
Template options include "template1" and "template2"
Examples
newthought("In this section")
## Not run:
# for Rmd to HTML
library(rmarkdown)
library(scientific)
rmdfile <- "input.Rmd"
rmarkdown::render(rmdfile,
scientific::html(
toc = TRUE,
toc_depth = 2))
## End(Not run)