go_indica_fi: Create an indicator fiche for a given aggregation of...

View source: R/go_indica_fi.R

go_indica_fiR Documentation

Create an indicator fiche for a given aggregation of countries.

Description

An auxiliary function to compile a rmarkdown file to produce the indicator fiche in html format within the output directory.

Usage

go_indica_fi(
  time_0 = NA,
  time_t = NA,
  timeName = NA,
  workDF = NA,
  indicaT = NA,
  indiType = c("highBest", "lowBest")[1],
  seleMeasure = "all",
  seleAggre = "EU27",
  x_angle = 45,
  data_res_download = FALSE,
  auth = "A.Student",
  dataNow = Sys.time(),
  outFile = NA,
  outDir = NA,
  pdf_out = FALSE,
  workTB = NULL,
  selfContained = FALSE
)

Arguments

time_0

starting time.

time_t

ending time.

timeName

name of the variable containing times (years).

workDF

name (string) of the dataset in the global environment containing all countries contributing to average.

indicaT

name of the considered indicator.

indiType

type of indicator "lowBest" or "highBest" (default).

seleMeasure

set of measures of convergence; this is a subset of the following collection of strings: "beta","delta", "gamma","sigma"; "all" is a shortcut for the whole set.

seleAggre

selection of member states, default 'EU27' ('custom' if not pre-coded).

x_angle

axis orientation for time labels, default 45.

data_res_download

should data and results be downloaded, default FALSE.

auth

author of this report, default 'A.Student'.

dataNow

date of production of this country fiche, default is current time.

outFile

name of the output file (without path), without extension.

outDir

output directory, eventually not existing (only one level allowed).

pdf_out

should the output be saved as PDF file? The default is FALSE.

workTB

a tibble containing data.

selfContained

TRUE if just one file is desired

Details

Note that most of function arguments are passed as strings of characters instead of object names. For example, if the object of a dataset in the workspace is myTB, the parameter is set like workDF='myTB' instead of workDF=myTB as one may expect. Furthermore, the dataset must be complete, that is without missing values. Note also that Internet connection should be available when invoking the function to properly rendering the results in the html file. The fiches have been tested with the browsers Mozilla Firefox and Google Chrome.

Value

No return value, called for side effects.

References

https://unimi2013-my.sharepoint.com/:u:/g/personal/federico_stefanini_unimi_it/EW0cVSIgbtZAvLPNbqcxdX8Bfn5VGSRHfAH88hQwc_RIEQ?e=MgtSZu


convergEU documentation built on March 7, 2023, 7:22 p.m.