Rnightlights (version 0.2.4)

printCredits: Format credits to print to the console

Description

Format credits to print to the console

Usage

printCredits(credits, newLineChar = "\n", surroundChar = "*",
  horzPadding = 1, vertPadding = 1, horzWidth = 3, vertWidth = 2)

Arguments

credits

character a single length character vector with newlineChar used to separate lines. Two consecutive newlineChara are used to put in a horizontal divider

newLineChar

character the character/sequence used to split the credits into new lines

surroundChar

character the character to use as a decoration

horzPadding

integer the number of blank spaces between text and the surrounding text horizontally

vertPadding

integer the number of blank spaces between text and the surrounding text vertically

horzWidth

integer the width of the decoration horizontally

vertWidth

integer the width of the decoration vertically

Value

character a formatted credits character vector

Examples

# NOT RUN {
  printCredits(credits="DMSP data collected by US Air Force Weather Agency|
  Image and data processing by NOAA's National Geophysical Data Center|
  (https://www.ngdc.noaa.gov/eog/download.html)||
  Maps distributed by GADM|(https://gadm.org)", newLineChar="|")

# }