FillExcelTemplate: Funktion befuellt ein Excel Template.

In statistikat/mzR: mzR - To compute estimates and their errors for Austrian microcensus data

Funktion befuellt ein Excel Template.

Description

Funktion liest ein Excel-File ein, uebernimmt die Formatvorlage eines ausgewaehlten Template-Excel-Sheets, befuellt die Kopie dieses Template-Excel-Sheets mit den Ergebnissen aus MakeTable und liest das Ergebnis samt urspruenglichem Template-Excel-Sheet (default) und dem neu befuellten Excel-Sheet wieder als Excel-File aus.

Usage

FillExcelTemplate(tab1, tab2 = NULL, startingPoints, nrEmptyRows,
  inheritTemplateColNr = 1, customColNr = NULL, customCol = NULL,
  customCellList = NULL, f_in, sheet = 1, prefixTSN = "_",
  removeTemplateSheet = FALSE, removeAllTemplates = FALSE,
  interactive = TRUE, showFinalTab = FALSE, showSplitTab = FALSE)

Arguments

tab1	eine mit MakeTable() bzw. MakeAKETimeInstantsTable() erzeugte Tabelle. Falls bei MakeTable() limits angegeben und einzelne Zellen mit Klammern oder Aehnlichem belegt wurden muss auch tab2 angegeben werden damit man die Werte in den Zellen bekommt.
tab2	NULL oder eine mit MakeTable() bzw. MakeAKETimeInstantsTable() erzeugte Tabelle bei der limits NICHT angegeben wurden. Diese Tabelle muss immer uebergeben werden wenn fuer die Erstellung von tab1 limits beruecksichtigt wurden.
startingPoints	numerischer Vektor: die Startzeilen der befuellten Zeilen nach Leerzeilen im Original-Excel-File.
nrEmptyRows	numerischer Vektor: Anzahl an Leerzeilen die vor startingPoints kommen sollen; eigentlich immer 1 ausser vor grossen Bloecken.
inheritTemplateColNr	numerischer Vektor oder NULL: Spaltennummer/n der Tabellenspalten die vom Original-Excel-File uebernommen werden sollen. Default ist die erste Spalte, also inheritTemplateColNr=1.
customColNr	numerischer Wert: Spaltennummer der Tabellenspalte (derzeit nur EINE moeglich) die ueber customCol individuell definiert werden soll und bei der die Leerzeilen im Gegensatz zum Parameter customCellList aus startingPoints und nrEmptyRows uebernommen werden sollen. Die Aufteilung von tab1 auf die Spalten der Excel-Tabelle wird dann automatisch angepasst, tab1 bzw. inheritTemplateColNr wird also nicht ueberschrieben.
customCol	character Vektor: Enthaelt die Eintraege der durch customColNr definierten Tabellenspalte - falls diese nicht aus dem Original-Excel-File uebernommen werden sollen und auch nicht durch MakeTable() generiert werden. Im Gegensatz zum Parameter customCellList wird hier ein Character Vektor OHNE Missings uebergeben, d.h. die ueber die Parameter startingPoints und nrEmptyRows definierten Leerzeilen werden einfach uebernommen und muessen nicht extra beruecksichtigt werden. Die Aufteilung von tab1 auf die Spalten der Excel-Tabelle wird dann automatisch angepasst, tab1 bzw. inheritTemplateColNr wird also nicht ueberschrieben.
customCellList	Listenobjekt: eine Liste (bzw. falls mehrere Zellen ueberschrieben werden sollen, eine Liste mit Sublisten) mit den Listenelementen row (numeric), col (numeric) und entry (character). Diese Listenelemente legen fest, welcher Zeile (row) und Spalte (col) die jeweilige Zelle entspricht und was dort eingetragen werden soll (entry). Um genau zu sein, legen row und col die jeweilige Start-Zeile und Start-Spalte in der Excel-Tabelle fest. Somit koennen auch ganze Tabellenzeilen/-spalten auf einmal ueberschrieben werden, dazu muss in entry lediglich ein Vektor der richtigen Laenge uebergeben werden. Siehe Examples. Dieser Parameter ist anzuwenden falls eine (oder mehrere) Zellen individuell angepasst werden sollen, z.B. um eine Fussnote einzufuegen oder um die Eintraege einer bestimmten Tabellenspalte mit bestimmten Inhalten zu ueberschreiben. Zu beachten ist hier, dass die entsprechenden Zellen einfach nur ueberschrieben werden und die Aufteilung von tab1 auf die Spalten der Excel-Tabelle in keiner Weise angepasst wird. Sollte man ZUSAETZLICH zu tab1 (und evt. auch zusaetzlich zu inheritTemplateColNr) eine neue Spalte hinzufuegen wollen so sind die Parameter customColNr bzw. customCol anzuwenden.
f_in	File Name inklusive Pfad und File-Endungen des eingelesenen Original-Excel-Files.
sheet	Index oder Name des Excel-Sheets oder des zugehoerigen Template-Excel-Sheets.
prefixTSN	Character: das Prefix des Namens des Template Sheets (siehe Details). Default ist "_".
removeTemplateSheet	TRUE/FALSE ob das Template-Excel-Sheet (mit dem Prefix prefixTSN) zum aktuell bearbeiteten Excel-Sheet geloescht werden soll, also ob es nicht im ausgelesenen File enthalten sein soll.
removeAllTemplates	TRUE/FALSE wie bei removeTemplateSheet, nur dass hier abgefragt wird, ob ALLE Template-Excel-Sheets, also alle Sheets mit dem Prefix prefixTSN, geloescht werden sollen, also ob das ausgelesene File keine Templates mehr enthalten soll.
interactive	Logical ob das Loeschen von Template-Sheets (removeTemplateSheet,removeAllTemplates) erst manuell durch den Nutzer bestaetigt werden soll.
showFinalTab	Logical: Falls TRUE, wird in R die Tabelle samt Leerzeilen ausgegeben wie sie auch im ausgelesenen Excel-File landen wuerde. Ist dieser Parameter gesetzt, wird also kein Excel-File erstellt.
showSplitTab	Logical: Falls TRUE, wird in R die durch startingPoints aufgesplittete Tabelle ausgegeben. Ist dieser Parameter gesetzt, wird also kein Excel-File erstellt.

Details

Ein Template-Excel-Sheet, das als Vorlage fuer das zu befuellende Excel-Sheet dient und i.d.R. leer ist bis auf einige Formate, Header und Rownames, wird durch ein Prefix im Sheet-Namen gekennzeichnet (prefixTSN). Der Sheet-Name ist bis auf das Prefix identisch zum Sheet-Namen des zu befuellenden neuen Excel-Sheets. Sollte entweder Template oder zu befuellendes neues Excel-Sheet noch nicht existieren, wird es automatisch angelegt. Die Template-Sheets koennen bei Bedarf wieder einzeln (removeTemplateSheet) oder alle auf einmal (removeAllTemplates) geloescht werden. Sollten sowohl das Template als auch das neue Sheet im File schon existieren ist es irrelevant ob bei sheet das Template oder das neue Sheet angegeben wird.

Derzeit funktioniert diese Funktion nur fuer die Default-Werte von markLeft1, markRight1, markValue1, markLeft2, markRight2 und markValue2 aus MakeTable() und MakeAKETimeInstantsTable().

Value

Output ist ein Excel-File.

See Also

MakeTable,MakeQT,ImportData,IndivImportData,ImportDataListQT

Examples

## Not run: 
###
Kommt wahrscheinlich ins mitgelieferte Bsp-File - samt Excel-Rohling.
###

### Beispiel einer customCellList:
# 1. die 1. Spalte der Tabelle soll ab der 1. Zeile der Tabelle die Eintraege 
# Category 1, Category 2 und Category 3 haben mit einer Leerzeile nach Category 1
# 2. wir wollen nur eine einzelne Zelle ansprechen und dort die Fussnote einfuegen 
# -> die 1. Spalte der Tabelle soll in Zeile 5 die Fussnote enthalten 
customCellList=list(
list(row=1,col=1,entry=c("Category 1", NA, "Category 2","Category 3")), 
list(row=5,col=1,entry="FussnoteBlaBlaText")
)
# bzw dasselbe in anderer Schreibweise:
customCellList <- list()
customCellList[[length(customCellList)+1]] <- 
list(row=1,col=1,entry=c("Category 1", NA, "Category 2","Category 3"))
customCellList[[length(customCellList)+1]] <- 
list(row=5,col=1,entry="FussnoteBlaBlaText")

## End(Not run)

statistikat/mzR documentation built on Aug. 25, 2023, 9:14 a.m.