Kiểu đặt tên biến trong R ưa thích của bạn là gì? [đóng cửa]

Bạn thích quy ước nào để đặt tên biến và hàm trong mã R?

Theo như tôi có thể nói, có một số quy ước khác nhau, tất cả đều cùng tồn tại trong sự hài hòa cacophonous:

1. Sử dụng dấu phân cách, ví dụ:

  stock.prices <- c(12.01, 10.12)
  col.names    <- c('symbol','price')

Ưu điểm: Có lịch sử ưu tiên trong cộng đồng R, phổ biến trong toàn bộ lõi R và được Hướng dẫn Kiểu R của Google đề xuất .

Nhược điểm: Đầy ẩn ý hướng đối tượng và gây nhầm lẫn cho người mới R

2. Sử dụng dấu gạch dưới

  stock_prices <- c(12.01, 10.12)
  col_names    <- c('symbol','price')

Ưu điểm: Một quy ước chung trong nhiều ngôn ngữ lập trình; được ưa chuộng bởi Hướng dẫn phong cách của Hadley Wickham và được sử dụng trong gói ggplot2 và plyr.

Nhược điểm: Không được lập trình viên R sử dụng trong lịch sử; được ánh xạ một cách khó chịu tới toán tử '<-' trong Emacs-Speaks-Statistics (có thể thay đổi bằng 'ess-toggle-underscore').

3. Sử dụng cách viết hoa hỗn hợp (camelCase)

  stockPrices <- c(12.01, 10.12)
  colNames    <- c('symbol','price')

Ưu điểm: Dường như được chấp nhận rộng rãi trong một số cộng đồng ngôn ngữ.

Nhược điểm: Có tiền lệ gần đây, nhưng không được sử dụng trong lịch sử (trong cơ sở R hoặc tài liệu của nó).

Cuối cùng, như thể nó chưa đủ khó hiểu, tôi phải chỉ ra rằng Hướng dẫn Kiểu của Google lập luận về ký hiệu dấu chấm cho các biến, nhưng viết hoa hỗn hợp cho các hàm.

Việc thiếu phong cách nhất quán giữa các gói R là vấn đề ở một số cấp độ. Từ quan điểm của nhà phát triển, nó làm cho việc duy trì và mở rộng mã của người khác trở nên khó khăn (đặc biệt là khi phong cách của nó không phù hợp với mã của bạn). Từ quan điểm của người dùng R, cú pháp không nhất quán sẽ mở ra đường cong học tập của R, bằng cách nhân các cách một khái niệm có thể được thể hiện (ví dụ: đó là hàm truyền ngày asDate (), as.date () hoặc as_date ()? Không, nó là. Ngày()).

Câu trả lời tốt trước đó nên chỉ cần thêm một chút ở đây:

• gạch dưới thực sự gây khó chịu cho người dùng ESS; do ESS được sử dụng khá rộng rãi, bạn sẽ không thấy nhiều dấu gạch dưới trong mã do người dùng ESS tạo ra (và tập hợp đó bao gồm một loạt các tác giả R Core cũng như CRAN, mặc dù có loại trừ như Hadley);

• dấu chấm cũng xấu vì chúng có thể bị lẫn lộn trong công văn phương pháp đơn giản; Tôi tin rằng tôi đã từng đọc các bình luận về hiệu ứng này trên một trong danh sách R: dấu chấm là một hiện vật lịch sử và không còn được khuyến khích;

• vì vậy chúng tôi có một người chiến thắng rõ ràng vẫn đang đứng ở vòng cuối cùng: camelCase. Tôi cũng không chắc liệu mình có thực sự đồng ý với nhận định 'thiếu ưu việt trong cộng đồng R' hay không.

Và vâng: chủ nghĩa thực dụng và sự nhất quán át chủ nghĩa giáo điều. Vì vậy, bất cứ điều gì hiệu quả và được sử dụng bởi các đồng nghiệp và đồng tác giả. Rốt cuộc, chúng ta vẫn còn khoảng trắng và dấu ngoặc nhọn để tranh luận :)

Tôi đã thực hiện một cuộc khảo sát về những quy ước đặt tên nào thực sự được sử dụng trên CRAN đã được chấp nhận cho Tạp chí R :) Dưới đây là biểu đồ tóm tắt kết quả:

Hóa ra (có lẽ không có gì ngạc nhiên) rằng lowCamelCase thường được sử dụng nhất cho các tên hàm và tên period.separated thường được sử dụng nhất cho các tham số. Tuy nhiên, để sử dụng UpperCamelCase, như hướng dẫn kiểu R của Google ủng hộ thì thực sự rất hiếm, và hơi lạ là họ lại ủng hộ việc sử dụng quy ước đặt tên đó.

Toàn bộ bài báo ở đây:

http://journal.r-project.org/archive/2012-2/RJournal_2012-2_Baaaath.pdf

Đánh dấu tất cả các cách! Trái với quan điểm phổ biến, có một số hàm trong cơ sở R sử dụng dấu gạch dưới. Chạy grep("^[^\\.]*$", apropos("_"), value = T)để xem tất cả.

Tôi sử dụng phong cách viết mã chính thức của Hadley ;)

Tôi thích camelCase khi lạc đà thực sự cung cấp một cái gì đó có ý nghĩa - như kiểu dữ liệu.

dfProfitLoss, trong đó df = dataframe

hoặc là

vdfMergedFiles (), nơi hàm nhận một vectơ và tạo ra một khung dữ liệu

Trong khi tôi nghĩ _ thực sự làm tăng khả năng đọc, dường như có quá nhiều vấn đề với việc sử dụng.-_ Hoặc các ký tự khác trong tên. Đặc biệt nếu bạn làm việc trên nhiều ngôn ngữ.

Điều này phụ thuộc vào sở thích cá nhân, nhưng tôi làm theo hướng dẫn về phong cách của google vì nó phù hợp với phong cách của nhóm cốt lõi. Tôi vẫn chưa thấy dấu gạch dưới trong một biến trong cơ sở R.

Như tôi đã chỉ ra ở đây:

Độ chi tiết của số nhận dạng ảnh hưởng đến hiệu suất của một lập trình viên như thế nào?

Cần lưu ý rằng các tên biến của bạn dễ hiểu như thế nào đối với đồng nghiệp / người dùng của bạn nếu họ không phải là người bản ngữ ...

Vì lý do đó, tôi muốn nói dấu gạch dưới và dấu chấm tốt hơn viết hoa, nhưng như bạn đã chỉ ra, tính nhất quán là điều cần thiết trong tập lệnh của bạn.

Như những người khác đã đề cập, dấu gạch dưới sẽ làm hỏng rất nhiều người. Không, nó không dài dòng nhưng nó cũng không đặc biệt phổ biến.

Sử dụng các dấu chấm làm dấu phân cách sẽ có một chút lông với các lớp S3 và những thứ tương tự.

Theo kinh nghiệm của tôi, có vẻ như rất nhiều người thích sử dụng R thích sử dụng camelCase, với một số cách sử dụng dấu chấm và một số dấu gạch dưới.

Thông thường, tôi đổi tên các biến của mình bằng cách sử dụng ix dấu gạch dưới và viết hoa hỗn hợp (camelCase). Các biến đơn giản được đặt tên bằng cách sử dụng dấu gạch dưới, ví dụ:

PSOE_votes -> số phiếu bầu cho PSOE (nhóm chính trị của Tây Ban Nha).

PSOE_states -> Categorical, cho biết trạng thái mà PSOE thắng {Aragon, Andalucia, ...)

PSOE_political_force -> Categorial, cho biết vị trí giữa các nhóm chính trị của PSOE {thứ nhất, thứ hai, thứ ba)

PSOE_07 -> Liên minh PSOE_votes + PSOE_states + PSOE_political_force tại 2007 (h eader -> phiếu bầu, tiểu bang, vị trí )

Nếu biến của tôi là kết quả của hàm được áp dụng trong một / hai Biến, tôi sử dụng cách viết hoa hỗn hợp.

Thí dụ:

positionXstates <- xtabs (~ trạng thái + vị trí, PSOE_07)

Tôi có sở thích đối với Vốn hỗn hợp.

Nhưng tôi thường sử dụng dấu chấm để chỉ ra loại biến là gì:

mixCapitals.mat là một ma trận. MixedCapitals.lm là một mô hình tuyến tính. mixCapitals.lst là một đối tượng danh sách.

và như thế.