O que deve ter uma funcao

Passos para uma boa proposta

Uma boa proposta é um dos principais passos para um bom trabalho, não só nessa disciplina¹⁾. Investir em uma boa descrição da função vai poupar trabalho posterior e ajuda a valorizar seu trabalho final. Nossa experiência demonstra que boas propostas normalmente levam a bons/ótimos trabalhos e que propostas mal planejadas derivam trabalhos medianos, em geral com maior esforço associado. Abaixo algumas dicas e sugestões para a sua proposta:

1. descreva claramente a tarefa que a função irá realizar, independente do contexto particular;
2. evite iniciar a descrição da proposta com o seus dados e sua área de atuação, tente descrever a tarefa o mais independente possível do grupo taxonômico, área de atuação ou preferências religiosas ou sexuais!
   • troque: minha função ira tratar os dados da circunferência da barriga de coelhos da páscoa que coletei na semana santa e fazer um teste de permutação da diferença entre as médias do tamanho da pança de machos e fêmeas
   • por: a função irá tratar dados de duas variáveis quantitativas e gerar um teste de permutação da diferença entre as médias das variáveis
3. caso sinta necessidade de explicar melhor a tarefa descrita no primeiro tópico, exemplifique o uso da função no contexto do seu trabalho (finalmente!), de preferência apenas como um dos usos da função!
4. defina claramente os objetos e argumentos de entrada da função:
   • evite: entra os dados da planilha que coletei em campo
   • use: um vetor numérico quantitivo, um dataframe com variáveis x e y, um argumento lógico de exclusão de NA, um argumento que define o tipo de índice que será calculado com as seguintes opções…
5. descreva claramente o objeto de saída e os gráficos gerados:
   • evite: vai gerar um analise de dados e um gráfico bonito
   • use: vai retornar um data-frame com as seguintes colunas…, uma lista com os seguintes resultados, um boxplot da variável y e um scatterplot de xy e a linha do modelo linear
6. tente ser conciso, uma proposta muito longa dificulta a correção. Explicações específicas devem ser colocadas em linques externos. Caso tenha algum conceito importante e específico, crie um linque para uma fonte confiável.
7. lembre-se: o R não faz mágica, se você não tem nenhum conhecimento sobre a tarefa que será executada pela sua função, vislumbramos dois caminhos: (1) aprender a fazer mágica; (2) pagar alguém que conheça a tarefa que será executada e domine o R! Desaconselhamos a buscar ambas as saídas: a mágica, porque não acreditamos e o programador porque vai sair caro!
8. Buque uma tarefa factível, mas que ao mesmo tempo seja um desafio estimulante e que te tire da zona de conforto!

TODAS AS LINHAS DO CÓDIGO DEVEM POSSUIR COMENTÁRIOS EXPLICATIVOS! TODAS!!

Os prazos foram mudados. Fique atento aos novos prazos.

Pontos considerados na avaliação do trabalho final

1. a função roda o exemplo do help;
2. a função cumpre a descrição da proposta acordada;
3. há generalidade no seu uso;
4. a documentação é adequada e informativa;
5. demonstra domínio básico da linguagem;
6. os comentários são informativos;
7. há redundâncias no código;
8. complexidade da tarefa executada;