Dokumentieren Sie eine glänzende Anwendung

8

Gibt es eine Möglichkeit, Dokumentation für eine glänzende Anwendung zu generieren?

Es wird sehr schwierig, eine glänzende Anwendung ohne Dokumentation aufrechtzuerhalten.

Es scheint, dass das gesamte Ökosystem der Tests / Dokumentation für eine R-Paketstruktur erstellt wurde. Vielleicht können wir dieses Verhalten für eine glänzende Anwendung emulieren / erweitern?

Ein Beispiel:

Ein reaktiver Ausdruck ist typischerweise ein R-glänzendes Element, das eine komplexe Datenstruktur enthalten kann.

%Vor%

Um mehr Kontext zu geben, bin ich hier im Zusammenhang mit dem Erstellen einer vollständigen Webanwendung mit R glänzend. Die gesamte Geschäftslogik ist in separate Pakete verpackt.

Zum Testen von Ui denke ich, dass es kompliziert ist (man kann zum Beispiel Rselenium verwenden), aber das Erzeugen von doc aus roxygen2 comments ist nur Parsing. Es sollte einfach sein, ein solches Werkzeug zu haben.

    
agstudy 08.07.2015, 22:33
quelle

2 Antworten

1

aktualisieren

Fügen Sie ein Beispiel für eine glänzende Anwendung

hinzu

Es gibt keine ideale Lösung, aber das ist im Grunde, was ich mache, um mit meinen glänzenden Anwendungen umzugehen, um eine robuste und gut "dokumentierte" glänzende Anwendung zu erstellen:

  • Erstelle ein Paket, in das du deine ganze Logik hineinlegst. Machen Sie sich keine Sorgen, die Input / Output-Struktur des Pakets als Argument aufzurufen. Versuchen Sie auch, einige Steuerelemente in Ihrem Paket zu erstellen. Zum Beispiel können Sie eine Inline-Version einiger einfacher glänzender Steuerelemente haben.

Ein typisches Paket wird diese Struktur haben:

%Vor%
  • Erstellen Sie eine glänzende Anwendung, die so strukturiert ist, dass sie Ihre verschiedenen Anwendungselemente widerspiegelt. Im Grunde erstellen Sie eine Ansicht / Server-Dateien für jede App-Seite. Sie können die glänzende Anwendung natürlich unter inst / ui stellen oder in ein separates Projekt einfügen.

Hier ein Beispiel:

%Vor%     
agstudy 25.06.2017, 04:14
quelle
1

Es ist eine gute Frage. Wie erstellen Sie eine komplexe Web-Anwendung mit Shiny? Ich glaube, dass ein großes Projekt zu organisieren ist die Schwäche der Shiny-Architektur.

Zuerst erstellt Shiny ein Web in nur einem HTML-Dokument. Dieses Dokument ist in mehrere Ebenen unterteilt, um eine große Anwendung zu entwickeln, die Sie benötigen, um die Ebenen korrekt zu verwalten. Allerdings stellt dieses Ding ein bedeutendes Problem dar, wie organisieren Sie den Code?

Nun, hier gibt es verschiedene Möglichkeiten, das zu tun. In der Tat können Sie verschiedene Methoden wie Joe Cheng anwenden:

In meinem Fall habe ich in einem riesigen Projekt das MVC-Muster implementiert, aber an die Shiny-Architektur angepasst.

    
Braisly 09.08.2015 09:57
quelle

Tags und Links