Convenções
Status 🟨🟨🟨
Marcações no Texto
A fim de facilitar a leitura e evidenciar itens importantes no texto, serão adotadas as seguintes marcações:
| Tipo do Texto | Marcação | Exemplo |
|---|---|---|
| Funções, argumentos, operadores do R | Código | print |
| Objetos criados no R (vetores, data frames, variáveis de data frames) e termos relevantes | Negrito | df_mtcars |
| Palavras de língua estrangeira | Itálico | pipe |
Nomes de Objetos
Abaixo convenções a serem usadas neste material.
| Tipo Objeto | Convenção | Exemplo |
|---|---|---|
| Data.frame, tibble ou data.table | snake_case iniciado por df (data frame) | df_clientes |
| Variáveis de datasets | SCREAMING_SNAKE_CASE | NOME_CLIENTE |
| Funções | camelCase iniciado por fn, sendo a primeira palavra após fn um verbo | fnBuscarClientes |
| Demais (vetores, listas, etc.) | snake_case | nomes_cidades |
Status do Material
Para indicação de status do material apresentado serão usados os símbolos abaixo no topo de cada capítulo:
| Indicador | Estrutura | Conteúdo | Status Geral |
|---|---|---|---|
| ⬛⬛⬛ | não iniciado | não iniciado | não iniciado |
| 🟨⬛🟨 | incipiente | não criado | incipiente |
| 🟨🟨🟨 | incipiente | incipiente | incipiente |
| 🟨🟦🟨 | incipiente | em revisão | incipiente |
| 🟦🟦🟦 | em revisão | em revisão | em revisão |
| 🟦🟩🟦 | em revisão | amadurecido | em revisão |
| 🟦🟨🟨 | em revisão | incipiente | incipiente |
| 🟨🟩🟨 | incipiente | amadurecido | incipiente |
| 🟨🟥🟥 | incipiente | desatualizado | desatualizado |
| 🟩🟨🟨 | amadurecido | incipiente | incipiente |
| 🟩🟦🟦 | amadurecido | em revisão | em revisão |
| 🟩🟥🟥 | amadurecido | desatualizado | desatualizado |
| 🟩🟩🟩 | amadurecido | amadurecido | amadurecido |
🟨 incipiente: recém iniciado, é o status mais volátil. Após melhores definições passa a ser marcado como 🟦.
🟦 em revisão: em alterações (grandes) para melhorias. Após este status será marcado como 🟩.
🟩 amadurecido: já passado por revisão. Pode sofrer pequenas alterações e atualizações. Caso se identifique que necessite de grandes alterações será marcado como:
🟦 para revisão por decisão
🟥 para revisão por desatualização
🟥 desatualizado: necessita ser reescrito por força maior, como desatualização de conceitos ou códigos.
⬛ não iniciado: serve como marcação de ‘todo’. usado para seções que se entendem necessárias mas que ainda não foram iniciadas.
Última atualização: 11/10/2024 - 21:46:49