Ich bin neu bei roxygen und habe Schwierigkeiten zu sehen, wie ich es verwenden kann, um schnell ein neues / benutzerdefiniertes Paket zu erstellen.
i.e. Ich würde gerne wissen, dass die Mindestanforderungen darin bestehen, ein Paket namens package1 mit devtools , roxygen2/3 zu erstellen, damit ich die Befehle
erzeugt 2000 bzw. 4000 zufällige Normalen
Also nehmen wir das einfachste Beispiel.
Wenn ich zwei Funktionen fun1 und fun2
und
%Vor% Die Parameter sind numerisch, die Rückgabewerte sind numerisch. Ich bin mir ziemlich sicher, dass dies keine S3-Methode ist, lasst uns die Titel fun1 und fun2 nennen ... ich bin mir nicht sicher, welche anderen Informationen ich bereitstellen müsste. Ich kann fun1 und fun2 in separate .R -Dateien setzen und ein bisschen #' hinzufügen, bin aber unsicher, alle relevanten Anforderungen für roxygen einzubeziehen und bin mir auch nicht sicher, was ich als relevante Voraussetzungen angeben und wie ich die rd-Dokumentation erstellen kann Geh mit einem Paket sind. Ich nehme an, der Namensraum würde nur die Namen fun1 und fun2 haben? und die Paketbeschreibung wäre nur einige allgemeine Informationen zu mir ... und die Funktion des Pakets?
Schritt für Schritt Anleitungen würden gerne erhalten.
EDIT: Das Unten ist, wie weit ich mit ... beginnen konnte.
Ich kann so weit gehen wie folgt, um ein Pacakge zu erstellen ... aber kann roxygen nicht verwenden, um die Dokumentation zu erstellen ...
%Vor%und hier bin ich mir nicht sicher, ob mir ein paar Schritte fehlen oder nicht ...
%Vor%Wenn ich versuche zu installieren, bekomme ich folgende Fehlermeldung
%Vor% Ich bin überrascht @hadley sagt, package.skeleton nicht in seinem kommentieren . Ich würde package.skeleton verwenden, roxygen Kommentarblöcke hinzufügen, dann alle Dateien im Verzeichnis "man" löschen und roxygenize ausführen. Da Hadley jedoch "Noooooooooo" sagt, ist hier das Minimum , das Sie in der Lage sein müssen, ein Paket zu erstellen, das R CMD prüft und Ihre Funktionen exportiert.
Erstellen Sie ein Verzeichnis namens "package1". Erstellen Sie unter diesem Verzeichnis eine Datei mit dem Namen DESCRIPTION, und fügen Sie sie ein (bearbeiten Sie sie, wenn Sie möchten):
Erstellen Sie nun ein Verzeichnis namens "R" und fügen Sie für jede Funktion eine Datei hinzu (oder Sie können beide Funktionen in die gleiche Datei einfügen, wenn Sie möchten). Ich habe 2 Dateien erstellt: fun1.R und fun2.R
Jetzt können Sie roxygenize Ihr Paket
Da Sie im Titel Ihres Q devtools erwähnt haben, könnten Sie die Funktionen build und install von devtools
Oder Sie können R verlassen und die mit R mitgelieferten Tools zum Erstellen / Überprüfen / Installieren verwenden.
%Vor%Jetzt feuern Sie R erneut an, um Ihr neues Paket zu verwenden.
%Vor%Aber das Ermitteln der Mindestanforderungen wird Ihnen (oder den Benutzern Ihres Pakets) wahrscheinlich nicht viel helfen. Es wäre viel besser, eines der vielen, vielen Pakete zu lesen, die roxgen2 verwenden.
Hier ist eine bessere Version der Datei fun1.R, die immer noch nicht alle roxygen-Tags verwendet, aber viel besser ist als das absolute
Viel später - Sie könnten RoxygenReady Ihre Funktionen mit der Funktion vorbereiten minimales Roxygen-Anmerkungsskelett. Es bringt Sie im Wesentlichen von Ihren 2 Eingabefunktionen zu GSee's Antwort, welche die Eingabe von Roxygen2 ist.