1.5 Szablon raportu

Szablon raportu opisuje zawartość generowanego raportu. W tym celu używany jest prosty język składu – markdown.

W języku tym pewne ustalone sekwencje znaków zamieniane są na konkretne formatowania w wynikowym dokumencie, np.:

• sekwencja: # To jest nagłówek spowoduje wygenerowanie nagłówka pierwszego poziomu o treści To jest nagłówek,
• sekwencja ## To jest inny nagłówek nagłówka drugiego poziomu o treści To jest inny nagłówek,
• a sekwencja Ten tekst nie jest pogrubiony, **a ten jest** akapitu, którego ostatnie trzy wyrazy pisane będą pogrubioną czcionką.

Sposób uzyskiwania poszczególnych formatowań, tabel, itp. opisany został w rozdziałach 1.5.1 oraz 1.5.4.

Dodatkowo w szablonie raportu osadzać można dowolny kod języka R, co pozwala na umieszczenie w wygenerowanym raporcie zawartości tworzonej dynamicznie – czy to na podstawie pliku definicji odbiorców czy pliku danych, np. zakładając że w pliku danych istnieje zmienna OCENA, możemy wstawić w raporcie średnią ocen za pomocą sekwencji r E(OCENA). Ta funkcjonalność opisana została w rozdziałach 1.5.2, 1.5.3, 1.5.5 i 1.5.6.

Uwaga! Tworzenie, zapisywanie i otwieranie szablonów raportów w programie RStudio, jak również uruchamianie generowania raportu na podstawie szablonu opisane zostało w rozdziale 1.1.1.

Każdy szablon raportu generowanego z użyciem pakietu MLAK rozpoczyna się:

• Nagłówkiem opisującym tytuł raportu oraz ostatnio wybrany format eksportu:

  ---
  title: "Tytuł raportu"
  output: pdf_document
  ---
  

  Pozostałe pola nagłówka (np. dodawane automatycznie przy tworzeniu nowego szablonu pola author czy date) są nieobowiązkowe i mogą zostać usunięte). Nagłówek opisuje również specyficzne dla poszczególnych formatów wyjściowych opcje eksportu – ich dostosowanie opisano w rozdziale 1.1.1.

• Wstawką R, która załaduje pakiet MLAK oraz wczyta dane z pliku danych (patrz rozdział 1.3) i przykładowego odbiorcę z pliku definicji odbiorców (patrz rozdział 1.4):

    ```{r, echo = FALSE, message = FALSE, warning = FALSE}
    library(MLAK)
    wczytajOdbiorce('ścieżkaDoPlikuOdbiorców', 'ścieżkaDoPlikuDanych')
    ```
  

Dalsza część szablonu raportu opisuje już jego treść.