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



\section{\texorpdfstring{Help}{Help}}
\label{sec:help}
\lstset{frame=single}
\begin{lstlisting}
quali.ambi                         package:unknown                     R Documentation

FUNÇÃO PARA A AVALIAÇÃO DA QUALIDADE AMBIENTAL DE ECOSSISTEMAS MARINHOS

Description:

A função quali.ambi fornece ao usuário uma avaliação da qualidade ambiental 
a partir de amostras da comunidade bentônica de um dado ecossistema marinho. Para tal, 
a função classifica os diferentes taxa da comunidade, fornecidos no objeto de entrada, 
em cinco diferentes grupos de bioindicadores. Efetuando o cálculo da abundância 
relativa por grupo e aplicando fórmulas específicas, a função classifica a área 
de acordo com seu nível de poluição e saúde da comunidade bentônica.

Usage:

quali.ambi(dados,N)

Arguments:

dados: dataframe com a abundância por amostra de cada taxa. Mínimo de duas colunas, 
uma com a lista de taxa e outra com a abundância por taxa da amostra.
 
N: Número total de amostras. Deve equivaler ao número de colunas numéricas 
do dataframe (dados) de entrada.

Details:

Para a função rodar será necessária uma tabela base contendo a classificação dos 
grupos bioindicadores por taxa bentônico, a qual foi elaborada por Borja et al. (2000) 
(complementada por Muniz et al. (2005) para ecossistemas no Atlântico da América do Sul) 
e está adaptada aqui para leitura no R (tabela_base.txt). Essa tabela base possuí duas 
colunas, uma com todos os taxa já classificados como bioindicadores (mais de 400 taxa) 
e outra com o respectivo grupo ao qual cada um pertence. A tabela deverá ser baixada 
para o diretório de trabalho do usuário antes de se usar a função.

A lista de taxa na 1ª coluna do objeto de entrada deve conter os nomes dos organismos 
ao nível taxonômico de gênero, com sua respectiva abundância por amostra nas demais 
colunas (ou apenas na segunda coluna, no caso de N=1). Apenas 6 grandes grupos da fauna 
bentônica não necessitam estarem especificados a nível de gênero, estes são:
 "Nematoda","Nemertea","Oligochaeta","Gammaridae","Plathelmintes" e "Sipuncula".
Para estes casos, o nome do grande grupo pode constar na 1ª coluna, sendo todos os 
demais em gênero.

Value:

Coeficiente biótico e Índice Biótico da(s) amostra(s).

Classificação do nível de poluição da(s) amostra(s) (de Não poluída à Extremamente 
Poluída).

Nível da saúde da comunidade da(s) amostra(s) (de Normal à Azóico).

Tabela com todos os taxa, suas abundâncias por amostra e seu respectivo grupo 
bioindicador.

Gráfico(s) com a porcentagem de cada grupo bioindicador na(s) amostra(s).

Gráfico dos índices e coeficientes bióticos por amostra (no caso de N>1).


Warning:

Atente-se para que a 1ª coluna do seu dataframe de entrada (dados), com a lista de 
taxa, seja da classe "character". Para tal, quando estiver criando o dataframe a partir 
de vetores no R, lembre-se de usar o argumento "stringsAsFactors = FALSE", para que sua 
lista de espécies não seja convertida para a classe "factor".     

É de suma importância que o nome do gênero (ou do grande grupo, se for o caso) esteja 
escrito corretamente no objeto de entrada. Ou seja, com a primeira letra maiúscula, 
demais letras minúsculas e não acompanhado por "sp.". Gêneros escritos incorretamente 
terão o grupo bioindicador classificado como "NA". Os taxa que não se encaixam 
classificados em nenhum grupo bioindicador também terão grupo classificado como "NA". 
Em ambos estes casos, os taxa em questão serão excluídos dos cálculos subsequentes e do 
resultado final da avaliação da qualidade ambiental das amostras. 

Author(s):

     Ivan Rodrigo Abrão Laurino
     ivanlaurino@usp.br

References:

     Borja, A., Franco, J., & Pérez, V. (2000). A marine biotic index to establish the 
     ecological quality of soft-bottom benthos within European estuarine and coastal 
     environments. Marine pollution bulletin, 40(12), 1100-1114.

     Grall, J., & Glémarec, M. (1997). Using biotic indices to estimate macrobenthic 
     community perturbations in the Bay of Brest. Estuarine, Coastal and Shelf Science, 
     44, 43-53.
     
     Muniz, P., Venturini, N., Pires-Vanin, A. M., Tommasi, L. R., & Borja, A. (2005).
     Testing the applicability of a Marine Biotic Index (AMBI) to assessing the 
     ecological quality of soft-bottom benthic communities, in the South America 
     Atlantic region. Marine Pollution Bulletin, 50(6), 624-637.


Examples:

# Exemplo 1: Dados com apenas uma amostra
taxa.1<-c("Sabella","Pseudopolydora","Sabellaria","Scolelepis","Heterocirrus","Scoloplos","Scrobicularia","Sertulariidae","Sextonia","Sigalion","Siphonoecetes","Sipuncula","Spio","Nematoda","Oligochaeta","Capitella","Spiophanes","Nemertea")         
praia.1<-c(sample(seq(from=0,to=1000,by=1),size=18))
comunidade.1<-data.frame(taxa.1,praia.1,stringsAsFactors = FALSE)
quali.ambi(dados=comunidade.1,N=1)

# Exemplo 2: Dados com 4 amostras
taxa.2<-c("Capitella","Monopylephorus","Pseudopolydora","Scolelepis","Scoloplos","Tubificoides","Heterocirrus","Scrobicularia","Sertulariidae","Sextonia","Sigalion","Siphonoecetes","Sipuncula","Spio","Nematoda","Oligochaeta","Spiophanes","Nemertea","Corbula","Tellina")         
praia.1<-c(20000,sample(seq(from=0,to=1000,by=1),size=19)) # inserindo alta abundância para o taxa "Capitella", reconhecido oportunista o qual domina áreas de reduzida qualidade ambiental
praia.2<-c(sample(seq(from=0,to=1000,by=10),size=20))
praia.3<-c(sample(seq(from=0,to=1000,by=20),size=20))
praia.4<-c(sample(seq(from=0,to=1000,by=50),size=20))
comunidade.2<-data.frame(taxa.2,praia.1,praia.2,praia.3,praia.4,stringsAsFactors = FALSE)
quali.ambi(dados=comunidade.2,N=4)

# Exemplo 3: Dados com 9 amostras que incluem taxa não classificados como bioindicadores ou com erro de escrita
taxa.3<-c("Capitella","Monopylephorus","Pseudopolydora","Scolelepis","Scoloplos","Tubificoides","Heterocirrus","Scrobicularia","Sertulariidae","Ucides","Sigalion","Siphonoecetes","Sipuncula","Spio","Nematoda","Oligochaeta","Spiophanes","Nemertea","corbula","Tellina","Sabella")         
praia.1<-c(20000,sample(seq(from=0,to=1000,by=1),size=20)) # inserindo alta abundância para o taxa "Capitella", reconhecido oportunista o qual domina áreas de reduzida qualidade ambiental
praia.2<-c(sample(seq(from=0,to=1000,by=10),size=21))
praia.3<-c(sample(seq(from=0,to=1000,by=20),size=21))
praia.4<-c(sample(seq(from=0,to=1000,by=50),size=21))
praia.5<-c(sample(seq(from=0,to=1000,by=10),size=21))
praia.6<-c(sample(seq(from=0,to=1000,by=20),size=21))
praia.7<-c(sample(seq(from=0,to=1000,by=50),size=21))
praia.8<-c(sample(seq(from=0,to=1000,by=20),size=21))
praia.9<-c(sample(seq(from=0,to=1000,by=10),size=20),20000) # inserindo alta abundância para o taxa "Sabella", reconhecido organismo sensível o qual só ocorre em áreas de melhor qualidade ambiental
comunidade.3<-data.frame(taxa.3,praia.1,praia.2,praia.3,praia.4,praia.5,praia.6,praia.7,praia.8,praia.9,stringsAsFactors = FALSE)
quali.ambi(dados=comunidade.3,N=9)
\end{lstlisting}



\end{document}
