Thiết kế tài liệu với RMarkdown

(Design Documents with RMarkdown)

Trát Quang Thụy

Ngày 20/2/2020


Logs

18.2.2020:

3.2.2020:

28.1.2020:

22.1.2020:

19.1.2020:


Mục lục

Cám ơn

Phần 1: Giới thiệu

0. Giới thiệu tổng quan: ddrIntroduction (28.1.2020)

  • Giới thiệu về dự án

  • Mục tiêu: Visualization nhưng thiên về Design (kĩ thuật, không phải mĩ thuật) với phạm vi public lên RPubs.

  • Qui ước giao tiếp (protocol): Người - Người, Người - Máy

    • Xưng hô
    • Ngôn ngữ Anh, Việt
    • Định dạng văn bản, tài liệu
    • Tổ chức tài liệu và cách đọc
    • Phần mềm (version tương ứng) để thực tập: VS Code (và Ext về theme, formatter, code snippets), R (cả RTools), RStudio (add-on Knitr), cả MySQL nếu cần xây dựng database.

Phần 2: Làm quen

1. Triết lí Design Documents (suy nghĩ một cách thông thái)

  • Kaizen vs. Revolution (“anything goes” - Paul Karl Feyerabend)
  • Chia để trị (module, component)
  • Tổ chức thông tin
    • Tính logic
    • Tính hệ thống
  • Khoa học vs. Nghệ thuật
  • Nguyên lí “Xây cái Toilet” (History)
  • Học người đi trước (‘đầu tiên và cũng là cuối cùng’ - Harry Potter)
    • Tiếp nhận
    • Phân tích
    • Bắt chước
    • Tùy biến
    • Sáng tạo

2. Mã hóa thông tin trong RMarkdown

  • Nguyên lí thông tin dưới góc độ khoa học máy tính (hệ bin, hex, dec; bit, byte/ word, double words)
  • Kí tự: Bảng mã ASCII (7-bit, 8-bit), UniCode
  • Chuỗi kí tự: Escape string, URI
  • Định dạng văn bản bằng đánh dấu (markup)
    • Markdown
    • LaTeX
    • HTML
    • CSS

3. Nguyên liệu chế biến Documents

  • Phát thảo khung sườn (template, skeleton, pattern)
  • Chọn chủ đề (theme)
  • Biến tấu phong cách (style)
  • Thổi hồn vào Documents (DHTML, JavaScript)
    • Batch và R functions (Bắt chước)
    • Script và Own R function (Tùy biến)
    • Language (Sáng tạo)

Phần 3: Làm thử

4. Định dạng chữ

5. Image, Address, Block, Code: ddrHyperText

6. Equation ddrEquation (19.2.2020)

7. Table (kable)

8. Graphic (ggplot2)

Phụ lục

Phụ lục 1: Các bảng mã thường dùng: ddrEncodingTables (19.2.2020)

Phụ lục 2: Convert UniCode sang Escape string

Phụ lục 3: Convert UniCode tổ hợp sang UniCode dựng sẵn

Phụ lục 4: Convert Equartion từ LaTeX sang MathML

Chú giải thuật ngữ Anh - Việt: ddrTerms