\documentclass[a4paper, oneside, 10pt]{article}
\usepackage[unicode]{hyperref}
\usepackage[utf8x]{inputenc}
\usepackage[english]{babel}
\usepackage{listings}
\date{\today}
\title{}
\author{}
\begin{document}



\textbf{help(analisar)}

Por favor, abra a planilha \href{http://ecor.ib.usp.br./doku.php?id=05_curso_antigo:r2018:alunos:trabalho_final:brenda.correa:aves.csv}{.:aves.csv} em seu diretório.\lstset{frame=single}
\begin{lstlisting}


analisar                        package:unknown       	           R Documentação


ANÁLISE DE ABUNDÂNCIA, RIQUEZA, DIVERSIDADE E EQUITABILIDADE A PARTIR DE PLANILHAS DE DADOS BRUTOS


Descrição:

   A função “analisar" calcula, a partir do input de uma planilha de dados brutos contendo dados de registro de 
   espécimes por local de amostragem, a abundância e riqueza total (considerando todos os locais de amostragem 
   conjuntamente) e local (considerando os locais de amostragem separadamente); os índices de diversidade e 
   equitabilidade de Shannon e/ou de Simpson, por local e total; e cria um gráfico de abundância relativa das 
   espécies considerando os dados de todos os locais de amostragem conjuntamente.

Uso:

   analisar <- function(x, indices = c("Shannon", "Simpson"), grafico = TRUE, save.csv = TRUE)

Argumentos:

   x = planilha em formato .csv, a ser importada, contendo, minimamente, uma coluna denominada “nome_cientifico", 
   que deverá conter o nome cientifico dos espécimes registrados, e outra coluna denominada “local", que deverá 
   conter o nome e/ou número dos locais de amostragem.

   indices = um vetor contendo os dois conjuntos de índices incorporados pela função e que podem ser escolhidos 
   pelo usuário: Shannon e/ou Simpson. Cada conjunto inclui os índices tanto de diversidade quanto de 
   Equitabilidade.

   gráfico = por padrão (TRUE), exporta arquivo denominado “Grafico_Abundancia.Relativa.png" para diretório de 
   trabalho, contendo gráfico de Abundância Relativa das Espécies confeccionado a partir dos dados totais, ou seja, 
   considerando todos os locais de amostragem conjuntamente. Caso FALSE, gráfico não é exportado.

   save.csv = por padrão (TRUE), exporta arquivo denominado “Resultados_Finais.csv" para diretório de trabalho, 
   contendo dataframe com resultados de abundância e riqueza total e local e resultados do(s) conjunto(s) de 
   índices escolhidos, Diversidade e Equitabilidade Shannon e/ou Diversidade e Equitabilidade de Simpson, total e 
   local. Caso FALSE, arquivo não é exportado.

Detalhes:

   A função “analisar" calcula, a partir do input de uma planilha de dados brutos no formato .csv contendo dados de 
   registro de espécimes (preenchidos em uma coluna denominada “nome_científico") por local de amostragem 
   (preenchido em uma coluna denominada “local"), a abundância e riqueza total (considerando todos os locais de 
   amostragem conjuntamente) e local (considerando os locais de amostragem separadamente). Também calcula, conforme 
   a escolha do usuário, os seguintes conjuntos de índices: Diversidade e Equitabilidade de Shannon e/ou 
   Diversidade e Equitabilidade de Simpson, total (para todos os locais de amostragem conjuntamente) e local (para 
   cada local de amostragem). Todos estes resultados são apresentados em um dataframe final único, que apresenta os 
   cálculos por local e total, e que pode, se escolhido pelo usuário, ser automaticamente exportado em um arquivo 
   denominado “Resultados_Finais.csv" para seu diretório de trabalho. A função ainda permite o cálculo da 
   abundância relativa das espécies, considerando todos os locais de amostragem conjuntamente, e a confecção de um 
   gráfico de abundância relativa das espécies, o qual, se escolhido pelo usuário, pode ser automaticamente 
   exportado em formato “Grafico_Abundancia.Relativa.png" para seu diretório de trabalho.

Avisos:

   A função não é capaz de detectar erros de digitação eventualmente presentes no arquivo de input. A função apenas 
   detecta e emite mensagem de atenção caso sejam encontradas células vazias na planilha, as quais são 
   desconsideradas nas análises feitas. Caso isso ocorra, recomenda-se que o usuário verifique e faça as devidas 
   correções em seus dados de input.

   Ademais, caso não seja selecionado um dos conjuntos de índices incorporados pela função, ou seja selecionado 
   outro índice diferente destes, a função retorna mensagem de erro. Neste caso, o usuário deverá corrigir o 
   preenchimento deste argumento.

Autora:

   Brenda Bogatzky Ribeiro Corrêa
   brenda.correa@usp.br

Exemplos:

   #Cálculo de Riqueza e Abundância, considerando os dois conjuntos de índices incorporados pela função (Shannon e 
   Simpson), salvando automaticamente o gráfico de abundância relativa das espécies e o arquivo .csv contendo 
   dataframe de resultados finais. Por favor, salve a planilha teste denominada "aves.csv" em sua pasta 
   diretório.
   analisar ("aves.csv", indices = c("Shannon","Simpson"),grafico = TRUE, save.csv = TRUE)


   #Cálculo de Riqueza e Abundância, considerando apenas o conjunto de índices de Shannon, sem exportar gráfico de 
   abundância relativa das espécies e exportando apenas arquivo .csv contendo dataframe de resultados finais. Por 
   favor, salve a planilha teste denominada "aves.csv" em sua pasta diretório.
   analisar ("aves.csv", indices = c("Shannon"),grafico = FALSE, save.csv = TRUE)


   #Cálculo de Riqueza e Abundância, considerando apenas o conjunto de índices de Simpson, sem exportar gráfico de 
   abundância relativa das espécies e sem exportars arquivo .csv contendo dataframe de resultados finais. Por 
   favor, salve a planilha teste denominada "aves.csv" em sua pasta diretório.
   analisar ("aves.csv", indices = c("Simpson"),grafico = FALSE, save.csv = FALSE)

\end{lstlisting}



\end{document}
