===== HELP =====

  obs.sim                      package: unknown                     R Documentation
  
  ANÁLISE ESTATÍSTICA DE DADOS OBSERVADOS x SIMULADOS COM MODELOS
  
  Description:
  
  A função obs.sim analisa a relação entre dados observados (ou experimentais) e dados resultantes da utilização de modelos de simulação (dados simulados ou estimados). Calcula os principais índices estatísticos utilizados, juntos ou separadamente, e gera um gráfico de dispersão com os dados observados e cada conjunto de dados simulados. 
  O gráfico de dispersão, apresenta a equação de regressão linear e r² (i.e. coeficiente de determinação), além de uma reta 1:1 para comparação de uma reta de regressão linear perfeita. 
  Essa função facilita a análise da relação entre os dados observados e simulados, uma vez que consegue realizar o cálculo de diversos índices e gerar todos os gráficos simultaneamente, os quais são, normalmente, feitos um de cada vez.
  
  Usage:
  
  obs.sim(obs,sim,indice)
  
  Arguments:
  
  obs: conjunto de dados observados (classe:numeric, obs ≥ 0)
  sim: conjuntos de dados simulados, cada conjunto em uma coluna diferente (classe: data.frame, sim ≥ 0)
  indice: índice(s) estatístico(s) desejado(s)
  Utilize: índice=“r2” para calcular somente o coeficiente de determinação (r²), “r” para calcular somente o       índice de Pearson (r), “d” para calcular somente o índice de concordância (d), “c” para calcular somente o   índice de confiança ou desempenho (c), “EM” para calcular somente o erro médio, “EAM” para calcular somente o   erro absoluto médio, “REQM” para calcular somente a raíz do erro quadrático médio, “EF” para calcular somente a   eficiência do método utilizado ou simulação realizada ou ”all” para calcular todos os índices acima.
  
  Detail:
  
  As análises estatísticas serão selecionadas de acordo com o índice selecionado, podendo ser r2, r, c, d, EM,   EAM, REQM, EF ou todos os índices (“all”). 
  Os índices disponíveis são: 
  r2 = (summary((lm(sim[,i]~obs)))$r.squared)
  r = cov(obs,sim[,i])/(sd(obs)*sd(sim[,i]))
  d = 1-(sum((sim[,i]-obs)^2)/sum((abs(sim[,i]-mean(obs))+abs(obs-mean(obs)))^2))
  c = (1-(sum((sim[,i]-obs)^2)/sum((abs(sim[,i]-mean(obs))+abs(obs-mean(obs)))^2)))*sqrt(sum((sim[,i]-mean(obs))^2)/sum((obs-mean(obs))^2))
  EM = (sum(sim[,i]-obs))/length(obs)
  EAM = (sum(abs(sim[,i]-obs)))/length(obs)
  REQM = sqrt(sum((sim[,i]-obs)^2))/length(obs)
  EF = 1-((sum((obs-mean(obs))^2)-sum((obs-sim[,i])^2))/sum((obs-mean(obs))^2))             
  
  Value:
  
  - data.frame com os resultados dos índices estatísticos escolhidos, sendo uma coluna de resultados para cada   coluna de dados simulados;
  - scatterplot dos dados observados e simulados pelo modelo, com a reta obtida com a regressão linear, o r² e   uma reta 1:1.
  
  Warning:
  
  obs é um número e é maior ou igual a zero? Se não, escreve: “obs precisa ser número e ≥ 0.”
  sim é um data.frame e é maior ou igual a zero? Se não, escreve: “sim precisa ser da classe data.frame e ≥ 0.”
  obs e sim apresentam mesma quantidade de dados? Se não, escreve: “obs e sim devem apresentar mesma quantidade de dados.”
  indice é diferente de all, r2, r, d, c, EM, EAM, REQM ou EF? Se for, escreve: “índice pode ser all, r2, r, d,   c, EM, EAM, REQM ou EF.” 
  
  Author:
  
  Paola de Figueiredo Bongiovani
  paola.f.bongiovani@gmail.com 
  
  
  References:
  
  CAMARGO, A. P.; SENTELHAS, P. C. Avaliação do desempenho de diferentes métodos de estimativa da   evapotranspiração potencial no estado de São Paulo. Revista Brasileira de Agrometeorologia, v. 5, n. 1, p. 89-  97, 1997.
  HOPKINS, W. G. Correlation coefficient: a new view of statistics, 2000.
  WILLMOTT, C. J. Some comments on the evaluation of model performance. Bulletin of the American Meteorological   Society, v. 63, n. 11, p. 1309–1313, 1982.
  
  
  Examples:
  
    * Exemplo de cálculo de “r2” com uma coluna de dados simulados:
  observado <- c(5.2,7.0,8.5,8.2,2.8,7.1,12.7,4.3,6.5,5.1)
  simulado <- data.frame(dados=c(6.4,3.5,8.1,8.2,8.9,8.7,7.1,5.2,6.1,4.3))
  obs.sim(observado, simulado, indice="r2")
  
    * Exemplo de cálculo de “c” com duas colunas de dados simulados:
  dados.obs <- c(95.2,87.0,78.5,78.2,82.8)
  dados.sim <- data.frame(y1=c(116.4,103.5,118.1,88.2,88.9), y2=c(11.2,14.7,17.5,3.9,8.9))
  obs.sim(dados.obs, dados.sim, indice="all")
  
    * Exemplo de cálculo de todos os índices com 4 colunas de dados simulados:
  obs <- c(95.2,87.0,78.5,78.2,82.8,77.1,102.7)
  sim <- data.frame(sim_1=c(116.4,103.5,118.1,88.2,88.9,88.7,87.1),   sim_2=c(111.2,104.7,117.5,83.9,78.9,78.7,85.4), sim_3=c(93.7,95.2,78.7,87.6,83.1,76.7,95.9),   sim_4=c(92.2,85.0,76.5,76.2,80.8,75.1,100.7))
  obs.sim(obs, sim, indice="all")