Package 'sciRmdTheme'

Title: Upgraded 'Rmarkdown' Themes for Scientific Writing
Description: A set of 'Rmarkdown' themes for creating scientific and professional documents. Simple interface with features to ease navigation across the page and sub-pages.
Authors: Obinna Obianom
Maintainer: Obinna Obianom <[email protected]>
License: MIT + file LICENSE
Version: 0.2
Built: 2024-11-20 05:20:20 UTC
Source: https://github.com/oobianom/scirmdtheme

Help Index


Create settings for Rmarkdown page

Description

Set options for the styling of the Rmarkdown theme to use on the page

Usage

set.theme(
  theme = c("default", "wide"),
  color = NULL,
  header.sticky = TRUE,
  header.image = NULL,
  header.color = NULL,
  list.group.icon = c("circle", "square", "star", "arrow", "quote", "heart"),
  font.family = NULL,
  font.color = NULL
)

Arguments

theme

theme to use for the page

color

primary color for the theme

header.sticky

make header sticky, TRUE or FALSE

header.image

include image such as logo in the header

header.color

color for the title of the page

list.group.icon

set a list group icon

font.family

set the font family

font.color

set the global text color

Value

styles for themeing the page

Demos for sciRmdTheme

More examples and demo pages for are located at this link - https://github.com/oobianom/sciRmdTheme.

Examples

set.theme("wide")
set.theme(
theme = "default",
color = "purple",
header.sticky=TRUE,
header.image="logo.png",
list.group.icon = "arrow",
font.family = "Arial",
font.color = "#333333",
header.color = "darkblue"
)