Dem Paket Daten beifügen
A.1 EnMoLMU R-Paket-Manuals
A.1.2 enmoSonstiges
September 7, 2015
Title Funktionen, um einige allgemeine Aufgaben zu erleichtern.
Version 1.0
Description Enhält r_source_dir, eine Funktion, um automatisch source-Befehle zu
allen R-Dateien (Dateien, die eine bestimmte Zeichenkette, wie ``.R''enthalten) zu erzeugen;
docu_pdf, um das Erstellen des Pdf-Manuals zu einem R-Paket zu erleichtern, pfad_ohne_datei um Pfad und Dateiname zu trennen und
finde_pakete, um Pakete, die in einem Source-Code geladen werden, aufzulisten.
Weiter sind Funktionen zum Erstellen der EnMoLMU-Ordnerstruktur enthalten.
Depends R (>= 3.1.2) License Keine Ahnung!
LazyData true Encoding UTF-8 Imports devtools,
roxygen2
R topics documented:
docu_pdf . . . . 1 enmolmu_ordnerstruktur . . . . 2 enmolmu_ordnerstruktur2 . . . . 3 enmoSonstiges . . . . 4 finde_pakete . . . . 4 komponente . . . . 5 pfad_ohne_datei . . . . 6 r_source_dir . . . . 6
Index 8
docu_pdf Erzeugen von Pdf-Manual zu einem Paket in einem Schritt
Description
Die Funktiondocu_pdferzeugt ein Pdf-Manual aus einem Paketordner in einem Schritt.
Usage
docu_pdf(paket, altes_pdf_loeschen = TRUE)
Arguments
paket Vollständiger Pfad (oder ab Arbeitsverzeichnis) und Name des Paketes, für das die Dokumentationspdf erzeugt werden soll.
altes_pdf_loeschen
Logical, soll eine bereits vorhandene pdf-Datei vorher gelöscht werden?
Details
Die R-Code-Dateien müssen UTF-8 kodiert sein.
Value
Schreibt und öffnet Paket-Manual als pdf.
Examples
## Not run: docu_pdf("C:/Users/Rottner/Documents/EnMoLMU/R Pakete/testpaket1", altes_pdf_loeschen = TRUE)
enmolmu_ordnerstruktur
Anlegen der EnMoLMU-Ordnerstruktur
Description
Die Funktion legt am angegebenen Ort die vorgeschlagene Ordnerstruktur an, also erzeugt die zum Ausführen von EnMoLMU benötigten Ordner und Unterordner.
Usage
enmolmu_ordnerstruktur(start)
Arguments
start Vollständiger Pfad und Name des die Ordnerstruktur beinhaltenden Ordners.
Details
Für eine leichter an Veränderungen anpassbare Variante sieheenmolmu_ordnerstruktur2. Beim
Gegenwärtigen Stand sind beide Funktionen gleichwertig. Für die Weiterentwicklung wirdenmolmu_ordnerstruktur2 empfohlen.
Value
Die Ordner und Unterordner werden im Verzeichnis start angelegt und auf der Console die erstellten Ordner aufgelistet.
Examples
## Not run:
enmolmu_ordnerstruktur(start = "C:/Users/Rottner/Documents/EnMoLMU/EnMoLMU_Ordnerstruktur2")
## End(Not run)
enmolmu_ordnerstruktur2
Anlegen der EnMoLMU-Ordnerstruktur
Description
Die Funktion legt am angegebenen Ort die vorgeschlagene Ordnerstruktur an, also erzeugt die zum Ausführen von EnMoLMU benötigten Ordner und Unterordner.
Usage
enmolmu_ordnerstruktur2(start)
Arguments
start Vollständiger Pfad und Name des die Ordnerstruktur beinhaltenden Ordners.
Details
Erzeugt dieselbe Ordnerstruktur wieenmolmu_ordnerstruktur, verwendet aber intern die Funk-tionkomponente, welche weit flexibler ist und eine einfachere und flexiblere Anpassung der Ord-nerstruktur in der künftigen Weiterentwicklung von EnMoLMU bzw. anderer Anwendungen für diese Funktion ermöglicht.
Value
Die Ordner und Unterordner werden im Verzeichnis start angelegt und auf der Console die erstellten Ordner aufgelistet.
Examples
## Not run:
enmolmu_ordnerstruktur2(start = "C:/Users/Rottner/Documents/EnMoLMU/EnMoLMU_Ordnerstruktur3")
## End(Not run)
enmoSonstiges Ein Paket mit einer Reihe von Zusatzfunktionen.
Description
Enhält r_source_dir, eine Funktion, um automatisch source-Befehle zu allen R-Dateien (Dateien, die eine bestimmte Zeichenkette, wie ".R"enthalten) zu erzeugen; docu_pdf, um das Erstellen des Pdf-Manuals zu einem R-Paket zu erleichtern, pfad_ohne_datei, um Pfad und Dateiname zu trennen und finde_pakete, um Pakete, die in einem Source-Code geladen werden, aufzulisten. Weiter sind Funktionen zum Anlegen der EnMoLMU Ordnerstruktur enthalten.
enmoSonstiges-Funktionen
siehe Hilfe zu docu_pdf, r_source_dir, pfad_ohne_datei und finde_pakete.
finde_pakete Alle in einem Source-Code verwendeten Pakete finden
Description
Die Funktionfinde_paketesucht in einer R-Code-Datei nach allen Aufrufen vonrequire und libraryund gibt eine Liste von den damit geladenen Paketen aus.
Usage
finde_pakete(datei, kommentiert = TRUE)
Arguments
datei Pfade und Name der Datei, die durchsucht werden soll.
kommentiert Sollen die auskommentierten Zeilen auch verwendet werden.
Value
Liste mit den geladenen Paketen ggf. mit auskommentierten Aufrufen.
Examples
## Not run: finde_pakete("Code_Daten/datenbank_funktionen.R")
## Not run: unique(unlist(lapply(dir(recursive = TRUE, pattern = ".R"), finde_pakete, kommentiert = FALSE)))
komponente Erzeugen einer Ordnerstruktur aus einer Liste
Description
Die Funktion erzeugt eine Ordnerstruktur, deren Aufbau über eine Liste festgelegt wird. Haupt-sächlich für die Verwendung durch die Funktionenmolmu_ordnerstruktur2gedacht.
Usage
komponente(element, name)
Arguments
element Eine Liste, in welcher weitere Listen oder character-Vektoren sind.
name Name des Ordners, in welchem diese Ordner angelegt werden sollen.
Details
Der Ordner name muss nicht existieren, da er von komponente angelegt wird. Die Elemente der Liste müssen ein character-Vektor sein, falls es zu den einzelnen Einträgen des Vektors keine weit-eren Unterordner mehr geben soll und eine Liste (list), falls die einzelnen Einträge wiederum Unterordner beinhalten sollen. Kommt beides vor (Ordner mit weiteren Unterordnern und Ord-ner ohne), so muss eine Liste verwendet werden und die OrdOrd-ner ohne UnterordOrd-ner in der Form
"Ordner3"=""angegeben werden (also als Vektor mit einem Leeren String als Inhalt und als Na-men der Name des Ordners).
Value
Legt die angegebenen Ordner an.
Examples
## Not run:
# Liste mit Struktur erstellen:
ebenen <- list("Berichte" = c("Berichte_fertig", "Berichtvorlagen"),
"Daten" = c("Famos", "GLT_hist", "GLT_updates", "sonstige_Daten", "Wetterdaten"),
"optional" = list("Entwicklung" = c("R-Pakete"), "R-Code"=""),
"Skripte" = c("batch", "R"))
# Ordner anlegen:
komponente(ebenen, "EnMoLMU_ordnerstruktur3")
## End(Not run)
pfad_ohne_datei Datei und Ordner aus Pfad extrahieren
Description
Extrahiert Pfad aus Pfad mit Datei, Pfad ohne letzten Ordner bzw. letzten Ordner/Datei ohne Pfad.
Usage
pfad_ohne_datei(pfad, datei = FALSE)
Arguments
pfad Character-Vektor aus Pfaden bzw. Pfaden mit Dateien
datei Logical (TRUE oder FALSE). Soll die Datei oder der letzte Ordner zurück-gegeben werden oder (TRUE) oder der Pfad dahin (FALSE). Default-Wert: FALSE.
Details
Sollte der Pfad mit einem Ordner enden, dürfen am Schluss keine "/" oder "\" mehr sein.
Value
Character-Vektor mit Pfaden oder Dateien/Ordnern Examples
pfad_ohne_datei(c("ordner1/ordner2/datei.R", "ordner1\\ordner2\\datei.docx",
"datei.csv"))
pfad_ohne_datei(c("ordner1/ordner2/datei.R", "ordner1\\ordner2\\datei.docx",
"ordner1/order2","datei.csv"), datei=T)
pfad_ohne_datei(c("ordner1/ordner2/datei.R", "ordner1\\ordner2\\datei.docx",
"ordner1/order2","datei.csv"), datei=F)
r_source_dir Source-Befehle erzeugen
Description
Funktion, um automatisch source-Befehle zu allen R-Dateien (Dateien, die eine bestimmte Zeichen-kette, wie ".R" enthalten) zu erzeugen
Usage
r_source_dir(pfad, pattern = ".R")
Arguments
pfad Ordner, in dem sich die Dateien befinden.
pattern Zeichenkette, die in den Namen aller Dateien vorhanden ist, für welche die source-Befehle erzeugt werden sollen (Default ist ".R").
Value
Gibt die Befehlszeilen in der Console aus, so dass sie in die Code-Datei kopiert werden können.
Examples
## Not run: r_source_dir("Code_Daten")
docu_pdf,1
enmolmu_ordnerstruktur,2,3 enmolmu_ordnerstruktur2,2,3,5 enmoSonstiges,4
enmoSonstiges-package(enmoSonstiges),4 finde_pakete,4
komponente,3,5 pfad_ohne_datei,6 r_source_dir,6