======Help_Vizinhos======

<code>

vizinhos                          package:unknown                     R Documentation

RANQUEAMENTO DOS LOCAIS COM MAIS VIZINHOS 
  

Description:

  Função para calcular o número de vizinhos de múltiplas localidades, em um raio 
  determinado. A função fornece uma tabela ranqueando os locais (pontos) em ordem 
  decrescente com relação ao número de vizinhos englobados em um determinado raio 
  de distância de cada local. Como produto colateral, a função gera o croqui com 
  a distribuição espacial dos locais e do conjunto de vizinhos testados, incluindo
  a projeção do raio em torno de cada local.

  
Usage:

  vizinhos(locais, vizi, raio, min.vizi, croqui)
  

Arguments:
 
  locais = Data frame com duas colunas indicando respectivamente os valores numéricos 
  das coordenadas x e y dos locais testados.

  vizi = Data frame com duas colunas indicando respectivamente os valores numéricos 
  das coordenadas x e y dos vizinhos testados.
 
  raio = Número maior que zero indicando o raio de abrangência no qual será computado 
  o número de vizinhos.
  
  min.vizi = Número inteiro maior que zero indicando o número mínimo de vizinhos a ser 
  considerado para ranquear os locais e apresentá-los no croqui. Locais com número de 
  vizinhos menor que o indicado neste argumento serão excluídos da análise. 

  croqui = Objeto da classe "logical" indicando a opção de gerar visualização gráfica 
  da distribuição espacial dos locais e dos vizinhos.

  
Details:
  
  A função tem como argumentos obrigatórios: "locais", "vizi" e "raio". 

  O argumento "min.vizi" é opcional, sendo o padrão min.vizi=0, o que significa que 
  serão ranqueados todos os locais, até mesmo os que não englobarem nenhum vizinho 
  no raio especificado. 

  Por padrão, croqui=TRUE, indicando geração de visualização gráfica.


Value:

  Tabela com locais ranqueados quanto ao número de vizinhos.

  Se croqui=TRUE: Croqui com locais (quadrados azuis), vizinhos (pontos verdes) e 
  projeção do raio de abrangência (círculos vermelhos, com transparência) a partir 
  de cada um dos locais.


Warning:
  
  Inserir argumentos em desacordo com as especificações descritas acima no item 
  "arguments" poderá acarretar na não execução da função.

  Linhas contendo NA(s) nos argumentos "locais" ou "vizi" serão excluídas.

  Números inseridos em "min.vizi" serão convertidos para "integer" caso não 
  pertençam a esta classe. Portanto números inseridos com casas decimais terão 
  seus décimos desconsiderados.

  A imagem gerada a partir do argumento "croqui" permite visualizar os locais e 
  vizinhos testados, mas a visualização gráfica de quais vizinhos foram incluídos 
  no raio mínimo pode apresentar inconsistências, sendo mais precisa a tabela gerada 
  como produto principal da função.

  Quando for utilizado o argumento croqui=TRUE (padrão), a função chama o pacote 
  "plotrix", que é necessário para plotar a projeção do "raio" a partir dos "locais".


Author(s):
  
  Rafael Barreiro Chaves
  e-mail: rafaecologia@gmail.com
  

Examples:

vizinhos(locais=data.frame(c(25,75,25,75),c(25,25,75,75)),vizi=data.frame(c(1,3,20,25,80,20,33,20,29,50,55,82,84,73,52,54,11,84,99,8),c(1,5,18,22,27,81,80,77,70,50,53,77,71,79,12,96,58,47,99,97)),raio=15) 
#exemplo simples para 4 locais e 20 vizinhos, a um raio de 15

vizinhos(locais=data.frame(c(25,75,25,75),c(25,25,75,75)),vizi=data.frame(c(1,3,20,25,80,20,33,20,29,50,55,82,84,73,52,54,11,84,99,8),c(1,5,18,22,27,81,80,77,70,50,53,77,71,79,12,96,58,47,99,97)),raio=15,min.vizi=2) 
#o exemplo anterior, agora incluindo o mínimo de 2 vizinhos

vizinhos(locais=data.frame(c(25,75,25,75),c(25,25,75,NA)),vizi=data.frame(c(1,3,NA,25,80,20,33,20,29,50,55,82,84,73,52,54,11,84,99,8),c(1,5,18,22,27,81,80,77,70,50,53,77,71,79,12,96,58,47,99,97)),raio=15,min.vizi=2) 
# o exemplo anterior, agora com NAs em 'locais' e 'vizi'

</code>