Skip to contents

This function initializes the setup for the myTide project. It sets up the required folders and configurations, and optionally starts a TiddlyWiki server either in MultiWikiServer (MWS) mode or regular mode.

Usage

init(
  tidepath = "myTide",
  mws = FALSE,
  tiddlywiki = NA,
  start_date = format(Sys.Date(), "%Y-%m-%d"),
  end_date = format(Sys.Date(), "%Y-%m-%d"),
  wikipath = NA
)

Arguments

tidepath

Character. The path where the tide folder will be created. Default is "myTide".

mws

Logical. Whether to set up the TiddlyWiki server in MultiWikiServer mode. Default is FALSE.

tiddlywiki

Character. The path to the TiddlyWiki installation. Default is NA. Only required for MWS.

start_date

Character. The start date for journal creation in YYYY-MM-DD format. Default is the current date.

end_date

Character. The end date for journal creation in YYYY-MM-DD format. Default is the current date.

wikipath

Character. The path where the wiki data will be stored. Default is NA.

Value

This function does not return a value but sets up the myTide environment.

Examples

if (FALSE) { # \dontrun{
init()
init(tidepath = "customPath", mws = TRUE, tiddlywiki = "path/to/tiddlywiki")
} # }