41.1 Chuẩn bị

# Install and load the latest version of the package from Github
pacman::p_load_current_gh("reconverse/reportfactory")
#remotes::install_github("reconverse/reportfactory") # alternative

41.2 Nhà máy mới

Để tạo một nhà máy mới, chạy hàm new_factory(). Thao tác này sẽ tạo một thư mục dự án R độc lập mới. Mặc định là:

• Nhà máy sẽ được thêm vào thư mục làm việc của bạn
  
• Tên của nhà máy dự án R sẽ được gọi là “new_factory.Rproj”
  
• Phiên RStudio của bạn sẽ “chuyển sang” dự án R này

# This will create the factory in the working directory
new_factory()

Nhìn vào bên trong nhà máy, bạn có thể thấy rằng các thư mục con và một số tệp đã được tạo tự động.

• Thư mục report_sources sẽ chứa các scripts R Markdown của bạn, các scripts này sẽ tạo ra các báo cáo của bạn
  
• Thư mục outputs sẽ chứa các kết quả đầu ra của báo cáo (ví dụ: HTML, Word, PDF, v.v.)
  
• Thư mục scripts có thể được sử dụng để lưu trữ các scripts R khác (ví dụ: được lấy từ các scripts Rmd của bạn)
  
• Thư mục data có thể được sử dụng để chứa dữ liệu của bạn (bao gồm các thư mục con “thô” và “sạch”)
  
• Tệp .here, vì vậy bạn có thể sử dụng here package để gọi các tệp trong thư mục con theo mối quan hệ của chúng với thư mục gốc này (xem chương [R projects] để biết thêm chi tiết)
• Tệp gitignore được tạo trong trường hợp bạn liên kết dự án R này với kho lưu trữ Github (xem [Version control and collaboration with Github])
  
• Tệp README trống, nếu bạn sử dụng kho lưu trữ Github

THẬN TRỌNG: tùy thuộc vào cài đặt máy tính của bạn, các tệp như “.here” có thể tồn tại nhưng ẩn.

Trong số các cài đặt mặc định, dưới đây là một số cài đặt mà bạn có thể điều chỉnh trong lệnh new_factory():

• factory = - Đặt tên cho thư mục gốc (mặc định là “new_factory”)
  
• path = - Chỉ định đường dẫn tệp cho nhà máy mới (mặc định là thư mục làm việc)
  
• report_sources = Đặt tên thay thế cho thư mục con chứa các R Markdown scripts (mặc định là “report_sources”)
  
• outputs = Đặt tên thay thế cho thư mục chứa kết quả đầu ra báo cáo (mặc định là “outputs”)

Xem ?new_factory để biết danh sách đầy đủ các đối số.

Khi bạn tạo nhà máy mới, phiên R của bạn được chuyển sang dự án R mới, vì vậy bạn nên tải lại package reportfactory.

pacman::p_load(reportfactory)

Bây giờ bạn có thể chạy lệnh factory_overview() để xem cấu trúc bên trong (tất cả các thư mục và tệp) trong nhà máy.

factory_overview()            # print overview of the factory to console

“Cây” các thư mục và tệp của nhà sản xuất được in ra R console. Lưu ý rằng trong thư mục “data” có các thư mục con cho dữ liệu “raw” (thô) và “clean” (sạch) cũng như dữ liệu CSV mẫu. Ngoài ra còn có “example_report.Rmd” trong thư mục “report_sources”.

41.3 Tạo báo cáo

Từ bên trong dự án R của nhà máy, hãy tạo báo cáo R Markdown giống như bạn thường làm và lưu nó vào thư mục “report_sources”. Xem chương [R Markdown][Reports with R Markdown] để biết hướng dẫn. Để ví dụ, chúng tôi đã thêm những thứ sau vào nhà máy:

• R markdown script mới có tên “daily_sitrep.Rmd”, được lưu trong thư mục “report_sources”
  
• Dữ liệu cho báo cáo (“linelist_cleaned.rds”), được lưu vào thư mục con “clean” trong thư mục “data”

Chúng ta có thể thấy bằng cách sử dụng factory_overview() R Markdown trong thư mục “report_sources” và tệp dữ liệu trong thư mục dữ liệu “clean” (được đánh dấu):

Dưới đây là ảnh chụp phần đầu của R Markdown “daily_sitrep.Rmd”. Bạn có thể thấy rằng định dạng đầu ra được đặt là HTML, thông qua tiêu đề YAML output: html_document.

Trong script đơn giản này, có các lệnh để:

• Tải các packages cần thiết
  
• Nhập dữ liệu danh sách dòng bằng đường dẫn tệp từ package here (đọc thêm trong chương [Import and export])

linelist <- import(here("data", "clean", "linelist_cleaned.rds"))

• In bảng tóm tắt các trường hợp và xuất nó với export() dưới dạng tệp .csv
  
• In một đường cong dịch tễ và xuất nó bằng ggsave () dưới dạng tệp .png

Bạn chỉ có thể xem lại danh sách các báo cáo R Markdown trong thư mục “report_sources” bằng lệnh này:

list_reports()

41.4 Biên soạn

Trong nhà máy báo cáo, để “biên soạn” báo cáo R Markdown có nghĩa là .Rmd script sẽ được chạy và đầu ra sẽ được tạo (như được chỉ định trong script YAML, ví dụ như HTML, Word, PDF, v.v.).

Nhà máy sẽ tự động tạo một thư mục được đánh dấu ngày tháng và thời gian cho các kết quả đầu ra trong thư mục “outputs”.

Bản thân báo cáo và mọi tệp đã xuất do script tạo ra (ví dụ: csv, png, xlsx) sẽ được lưu vào thư mục này. Ngoài ra, bản thân script Rmd sẽ được lưu trong thư mục này, vì vậy bạn có bản ghi của phiên bản script đó.

Điều này trái ngược với hoạt động bình thường của R Markdown “knitted” (kết hợp), lưu kết quả đầu ra vào vị trí của script Rmd. Hành vi mặc định này có thể dẫn đến các thư mục đông đúc, lộn xộn. Nhà máy nhằm mục đích cải thiện tổ chức khi một người cần chạy báo cáo thường xuyên.

Biên soạn theo tên

Bạn có thể biên dịch một báo cáo cụ thể bằng cách chạy compile_reports() và đặt tên Rmd script (không có phần mở rộng .Rmd) cho reports =. Để đơn giản hơn, bạn có thể bỏ qua reports = và chỉ cần viết tên R Markdown trong dấu ngoặc kép, như bên dưới.

Lệnh này sẽ chỉ biên dịch báo cáo “daily_sitrep.Rmd”, lưu báo cáo HTML, xuất bảng .csv và đường cong dịch bệnh .png vào một thư mục con được đóng dấu ngày và giờ cụ thể cho báo cáo, trong thư mục “outputs” .

Lưu ý rằng nếu bạn chọn cung cấp phần mở rộng .Rmd, bạn phải nhập chính xác phần mở rộng vì nó được lưu trong tên tệp (.rmd so với .Rmd).

Cũng lưu ý rằng khi biên soạn, bạn có thể thấy một số tệp tạm thời xuất hiện trong thư mục “report_sources” - nhưng chúng sẽ sớm biến mất khi chúng được chuyển đến đúng thư mục “output”.

# Compile the second and fourth Rmds in the "report_sources" folder
compile_reports(reports = c(2, 4))

Biên soạn tất cả

Bạn có thể biên soạn tất cả báo cáo R Markdown trong thư mục “report_sources” bằng cách đặt đối số report = thành TRUE.

compile_reports(
     reports = "summary_for_partners.Rmd",
     subfolder = "for_partners")

compile_reports(reports = "for_partners/")

compile_reports(
  reports = "daily_sitrep.Rmd",
  params = list(most_recent_data = TRUE,
                region = "NORTHERN",
                rates_denominator = 10000),
  subfolder = "regional"
)

41.5 Kết quả đầu ra

Sau khi chúng ta đã biên soạn các báo cáo một vài lần, thư mục “outputs” có thể trông giống như sau (các điểm nổi bật được thêm vào để rõ ràng):

• Trong “outputs”, các thư mục con đã được tạo cho mỗi báo cáo Rmd
  
• Trong đó, các thư mục con khác đã được tạo cho mỗi lần biên soạn duy nhất
  • Đây là những ngày tháng và thời gian được đóng dấu (“2021-04-23_T11-07-36” có nghĩa là ngày 23 tháng 4 năm 2021 lúc 11:07:36)
  • Bạn có thể chỉnh sửa định dạng dấu ngày/giờ. Xem ?compile_reports
    
• Trong mỗi thư mục ngày/giờ được biên soạn, kết quả báo cáo được lưu trữ (ví dụ: HTML, PDF, Word) cùng với tập lệnh Rmd (kiểm soát phiên bản!) Và bất kỳ tệp nào được xuất khác (ví dụ: table.csv, translate_curve.png)

Đây là chế độ xem bên trong một trong các thư mục được đánh dấu ngày/giờ cho báo cáo “daily_sitrep”. Đường dẫn tệp được đánh dấu bằng màu vàng để nhấn mạnh.

Cuối cùng, bên dưới là ảnh chụp màn hình của kết quả báo cáo HTML.

Bạn có thể sử dụng list_outputs() để xem lại danh sách các kết quả đầu ra.

41.6 Mục khác

41.7 Tài nguyên

Xem Github page của reportfactory package

Xem Github page của rfextras package