xgx_dirs2char: Append filenames to bottom of the plot

Description Usage Arguments Value Examples

View source: R/xgx_dirs2char.R

Description

xgx_dirs2char returns a character variable based on the dirs list. The caption gives the filename

Usage

1
xgx_dirs2char(dirs, include_time = TRUE)

Arguments

dirs

list containing directories and filenames. It must contain five fields

  1. parent_dir = Parent directory containing the Rscript and the Results folder

  2. rscript_dir = Subdirectory ofparent_dir that contains the Rscript used to generate the figure

  3. rscript_name= Name of the Rscript used to generate the figure

  4. results_dir = Subdirectory ofparent_dir where the figure is stored

  5. filename = Filename

include_time

is logical with default TRUE. If TRUE, it includes date / time in the output character

Value

character

Examples

1
2
3
4
5
6
dirs <- list(parent_dir = "/your/parent/path/",
            rscript_dir = "./Rscripts/",
            rscript_name = "Example.R",
            results_dir = "./Results/",
            filename = "your_file_name.png")
caption <- xgx_dirs2char(dirs)

xgxr documentation built on April 23, 2021, 1:07 a.m.