\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}


explor.an                packages: MASS, vegan               R Documentation

Função que realiza um conjunto de análises exploratórias a partir de dados 
quantitativos das espécies por paisagem e do gradiente numérico das variáveis 
ambientais. 

Description:

 Produz um data frame com o número total de indivíduos por paisagem, o número de 
 espécies/paisagem e as proporções de indivíduos e espécies por paisagem - que pode 
 ser escrito como um arquivo 'csv' no diretório de trabalho. Se @ usuari@ desejar a 
 função roda um modelo linear generalizado do número de indivíduos e espécies em 
 relação à variável ambiental da paisagens. A função também resulta 
 em um gráfico da distribuição da abundância ponderada das espécies de acordo com 
 o gradiente da variável selecionada pel@ usuári@ das paisagens.

Usage:

 explor.an(x, y, tabela=TRUE, graph=TRUE, glm=TRUE, family=poisson)

Arguments:

 x: data frame com dados numéricos do número de espécies.
 y: data frame com dados numéricos do gradiente da variável ambiental.
 tabela: cria arquivo csv no diretório de trabalho.
 graph: cria o gráfico de distribuição de espécies
 glm: roda um glm com o número de indivíduos e espécies pela variável ambiental.
 family: seleciona a família de distribuição dos dados

Details:

 Necessário o pacote MASS para a função ser executada.
 O número total de espécies por paisagem é calculado a partir de uma matrix binária
 dos dados, que é transformada dentro da função.
 O gráfico de distribuição das espécies é criado a partir da abundância ponderada das
 espécies. Esta abundância é ordenada de maneira decrescente ao longo do gradiente
 ambiental decrescente. 

Value:

 Um gráfico é gerado quando 'graph=TRUE'. 
 Uma tabela em arquivo csv é criado se 'tabela=TRUE'.
 Um data frame é retornado com os valores do número de indivíduos, número de espécies, 
 proporção de indivíduos e de espécies, por paisagem.
 Quando glm='TRUE' são rodados dois modelos: um com o número de indivíduos e outro com número de espécies
  pela variável ambiental selecionada.

Warning:

 Esta função realiza tarefas para fins exploratórios apenas.

 Se algum dos argumentos for inserido de forma incorreta a função não será executada.

Author(s):

 Pâmela Friedemann

 pfriedemann@usp.br

References:
 
 R documentation.

 Rodolfo Dirzo, Hillary S. Young, Mauro Galetti, Gerardo Ceballos, Nick J. B. Isaac,
 Ben Collen. Defaunation in the Anthropocene. Science 2014:401-406

 Pievani, T. The sixth mass extinction: Anthropocene and the human impact on biodiversity.
 Rend. Fis. Acc. Lincei 2014: 85-93.

Examples:

#### Example 1 ####

# pacotes necessarios:

 # install.packages("vegan") # instalar vegan caso nao tenha
 library(vegan)
 # install.packages("MASS") # instalar MASS caso nao tenha
 library(MASS)

# dados especies

 data(dune)
 data(dune.env)
 x <- dune	# dado numero de especies (colunas) por paisagem (linhas)

# dados ambientais:
 y <- dune.env # dados dos valores das variaveis ambientais (colunas) por 
  # paisagem (linhas)

# funcao:
 explor.an(x,y$A1,tabela=T,graph=T,glm=T,gaussian)

##### Example 2 ####

# pacotes necessarios:

 # install.packages("vegan") # instalar vegan caso nao tenha
 library(vegan)
 # install.packages("MASS") # instalar MASS caso nao tenha
 library(MASS)

# dados especies:

 mat <- matrix(ncol=15,nrow=25)
 mat[1:12,] <- round(abs(replicate(15,rnorm(12,mean=3,sd=2))))
 mat[13:25,] <- round(abs(replicate(15,rnorm(13,mean=7,sd=4))))
 dado.sp <- data.frame(mat)
 pref <- "sp"
 suf <- seq(1:15)
 colnames(dado.sp) <- paste(pref, suf, sep="")
 rownames(dado.sp)<- letters[1:25]


# dados ambientais:

 dado.amb <- data.frame(	# dados dos valores das variaveis ambientais (colunas) por paisagem (linhas)
	var1=seq(10,130,5), 
	var2=sample(99:300,size=25), 
	var3=rnorm(25,mean=100,sd=45),
	var4=rep(letters[1:5],each=5),
      var5=seq(-130,-10,5)
	 )
 colnames(dado.amb)
 rownames(dado.amb) <- letters[1:25]

# funcao:
 explor.an(dado.sp,dado.amb$var3,tabela=T,graph=T,glm=T,family=poisson)

# funcao: exemplo de variavel nao adequada, COM mensagem de erro
 explor.an(dado.sp,dado.amb$var4,tabela=F,graph=T,glm=F,family=poisson)


\end{lstlisting}



\end{document}
