Chuẩn bị dữ liệu để chia sẻ: viết tài liệu mô tả cho người chưa từng gặp bạn

Một bộ dữ liệu công khai mà không có tài liệu mô tả là một bảng số không ai giải mã được — kể cả chính bạn sau hai năm.

Phần lớn công sức chuẩn bị dữ liệu nằm ở tài liệu mô tả, không ở việc tải tệp lên.

Tài liệu mô tả cần có

• Từng biến: tên, ý nghĩa, đơn vị, khoảng giá trị hợp lệ.
• Cách mã hoá biến phân loại.
• Giá trị thiếu được mã thế nào và vì sao thiếu.
• Cách thu thập và thời gian thu thập.
• Các bước xử lý đã áp dụng trước khi công bố.

Trước khi tải lên

• Xoá hoặc mã hoá mọi thông tin nhận dạng cá nhân.
• Kiểm cả các trường gián tiếp có thể nhận dạng được khi kết hợp.
• Kiểm quyền: bạn có được phép chia sẻ không.
• Kiểm sự đồng ý của người tham gia có bao gồm việc chia sẻ không.

Định dạng

• Dùng định dạng mở, đọc được bằng nhiều phần mềm.
• Tránh định dạng riêng của một phần mềm cụ thể.
• Một tệp một bảng, tên cột không dấu và không khoảng trắng.
• Kèm mã nguồn phân tích nếu có.

Nơi đăng

• Kho có cấp định danh bền.
• Kho chuyên ngành nếu lĩnh vực có.
• Kho của cơ sở là lựa chọn mặc định tốt.
• Không đăng trên trang cá nhân hoặc dịch vụ lưu trữ tạm.

Đánh phiên bản

• Ghi số phiên bản ngay từ bản đầu tiên.
• Sửa lỗi thì tạo phiên bản mới, không ghi đè.
• Giữ các phiên bản cũ truy cập được.
• Người đã dùng bản cũ cần nó để tái lập kết quả của họ.

Một điều đáng nhớ

Viết tài liệu mô tả cho một người chưa từng gặp bạn và không thể hỏi bạn.

Đó chính xác là người sẽ dùng dữ liệu của bạn. Phép thử đơn giản: đưa cho một đồng nghiệp không tham gia dự án và xem họ có phân tích được không mà không hỏi bạn câu nào.

Câu hỏi thường gặp