This function acts as an entry point for the initialisation of the yaml generation.

init(
authors = "author",
date = lubridate::today(),
affiliation = NULL,
dir = ".",
left = "yes",
right = NULL,
navbar_title = "Title",
title = "siteymlgen",
categories = NULL,
name = NULL,
output_dir = NULL,
include = NULL,
exclude = NULL,
toc = FALSE,
toc_depth = NULL,
toc_title = NULL,
toc_float = FALSE,
theme = "united",
highlight = NULL,
css = NULL,
file = NULL
)

## Arguments

authors A character or vector of characters of authors to add to the _site.yml A character or a vector of characters describing the date A character or a vector of characters describing the authors affiliation. The affiliation which must match the length of the vector supplied to name. The directory of the Rmarkdown documents that you want automatically built into a _site.yml file. A TRUE or FALSE value that determines if you want your navigation bar left aligned. This is the default location. A TRUE or FALSE value that determines if you want your navigation bar right aligned. Left aligned is the default location The title of the navigation bar. If none supplied this defaults to "Title" A character describing the title of the website. This defaults to "siteymlgen" if no value is supplied A character or vector of characters describing the categories for the website. A character or a vector of characters describing the name of the author(s) A character describing the output directory name for the final Rmarkdown website. A character or vector of characters detailing the extra files to include in the final Rmarkdown build A character or vector of characters detailing the files not to include in the final Rmarkdown build Specify whether a table of contents is required for your website, defaults to TRUE An integer to specify the depth of the table of contents A character that sets the toable of contents title A boolean to specify if the table of contents is static or floats. defaults to FALSE. An Rmarkdown theme to set the render output. Defaults to 'united'. Syntax highlighting style for html_output from the rmarkdown package. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass NULL to prevent syntax highlighting Specify custom css. Specify the output filename.

## Value

A _site.yml file populated with yaml code.

## Examples

init(authors = c("Adam","Paul"), left="yes",
navbar_title = "Main title", title = "hello",
categories=c("r", "reprodicibility"), file=tempdir())#> Warning: cannot create file '/var/folders/jt/bvxj7lt53hzbqnd8mdfsn6vm0000gr/T//Rtmp6uVoUO', reason 'Is a directory'#> Warning: No file variable has been specified. Please specify one.
#>       Typically init(file='_site.yml')