Nomenclaturas de variáveis e funções

Uma regra importante ao você montar um código é documentá-lo e que ele deve ser escrito para ser legível, ou seja, que ele possa ser lido por outras pessoas, incluindo você no futuro. Seguem três princípios para denominar os objetos no R:

1. Os nomes devem significar algo.
2. Os nomes devem ser os mais curtos possíveis.
3. Com base em sua percepção, equilibre (1) e (2).

O terceiro é onde começa a complicação. Usamos “i” ou “n” por convenção para variáveis inteiras em loops? Sim, em geral, nós fazemos. Escolhemos “inv_logit” ou “inverse_logit”? Stan escolheu “inv_logit”. Escolhemos “complex” ou “complex_number”? C++ escolheu “complex”, bem como escolheu “imag” em vez de “imaginary” para o método de extrair o componente imaginário.

Usamos nomes como “run_helper_function”, que é longo e não fornece nenhuma pista sobre o que ele faz? Não, se quisermos fazer aos outros o que gostaríamos que fizessem a nós.

Regras para a nomenclatura de variáveis

Há alguma regras que precisam ser consideradas quando criamos variáveis:

• Podem conter letras: `exemplo``.
• Podem conter números: exemplo1.
• Podem conter underscores: exemplo_1.
• Podem conter pontos: exemplo.1
• Não podem ser iniciadas por números: 2example.
• Não podem ser iniciadas por underscores: _example
• Não podem ser iniciadas por ponto, se esse for imediatamente seguido por um número: .2exemplo.

Exercício

Quais dos seguintes nomes de variáveis são válidos Which of the following variable names are valid?

• weekly+tasks
• task2Do
• 24hour
• .task

Fonte: CARPENTER, Bob, Naming conventions for variables, functions, etc. R bloggers. March 11, 2020. Disponível em: https://www.r-bloggers.com/2020/03/naming-conventions-for-variables-functions-etc/.