\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 A}{Help A}}
\label{sec:help_a}
\lstset{frame=single}
\begin{lstlisting}


anim.msd                     package: nenhum                   R Documentation

Animação dos Desvios Mínimos de uma Regressão Linear

Description:

A função apresenta e salva no diretório de trabalho uma animação em GIF demostrando a 
mudança no tamanho dos resíduos para diferentes retas de uma regressão linear, à medida 
que o coeficiente de inclinação muda. No final da animação é apresentada a reta com o 
melhor ajuste. Além disso, a função retorna um summary da regressão linear da variável 
y em função da variável x.

Usage:

anim.msd= (x, y, ...)

## Default
anim.msd(x, y, lim=1, int=0.05, cor= "tot", name="animation.gif", time=1, xlabel="X", 
ylabel="Y")

Arguments:

x	vetor numérico da variável preditora quantitativa.

y	vetor numérico da variável resposta quantitativa.

lim	valor positivo que será somado ou subtraído ao coeficiente de inclinação do 
	melhor modelo 	da regressão linear e que estabelecerá um intervalo com os 
	limites superior e inferior das inclinações mostradas pela animação. Para 
	melhor visualização 0 ≤ lim ≤ 20, ao usar valores próximo a 20 recomenda-
	se utilizar um int ≥ 0.5.  Default de lim=1.
  
int	valor positivo que determina a diferença entre as inclinações de cada reta 
	plotada dentro do intervalo estabelecido por lim. Para melhor visualização 
	0.01 ≤ int ≤ lim. Default de int=0.05.

time	tempo em segundos entre uma imagem (i.e. plot ou frame) e a próxima, 
	controlando a velocidade da animação. Para melhor visualização 
	0.01 ≤ time ≤ 5. O default é time=1.

cor	indica se as cores vermelha e verde serão computadas para o conjunto dos 
	tamanhos dos desvios (“tot"), ou se serão computadas para cada desvio 
	separadamente (“ind"). Default de cor="tot".

name	nome que será dado à animação em GIF. O default é name="animation.gif". Ao 
	mudar o nome sempre manter a extensão '.gif'.

xlabel	nome do eixo x, deve ser colocado entre aspas.

ylabel	nome do eixo y, deve ser colocado entre aspas.


Details:

O método de minimizar a soma dos desvios quadráticos, ou resíduos, entre os valores 
observados e esperados (i.e. aqueles providos pelo próprio modelo) de uma variável 
resposta é amplamente utilizado como técnica de ajuste dos modelos para um conjunto 
de dados. A regressão linear simples é uma análise bastante comum e a compreensão da 
sua lógica auxilia no entendimento de outros tipos de análises mais complexas.

Na animação quando o tamanho dos resíduos aumenta, ao mudar a inclinação da reta, os 
segmentos são plotados em vermelho e quando os resíduos diminuem, eles são plotados 
em verde. No primeiro plot os segmentos estão em preto, uma vez que não há um valor 
anterior para comparação. O ponto vermelho mostrado é ponto do fulcro, com os valores 
das médias para as variáveis x e y. A reta azul que aparece no final da animação é 
aquela com o melhor ajuste.

Essa função utiliza a função 'saveGIF' do pacote 'animation' para converter diferentes 
imagens em um único arquivo usando o software ImageMagick 
(disponível em http://www.imagemagick.org/script/index.php).

Value:

anim.msd retorna uma janela gráfica com uma animação em GIF e uma lista com o resultado 
da função summary() aplicada à função lm().

Warning:

A função é interrompida e mensagens de erro são retornadas quando:

1) o pacote 'animation' não é encontrado ao usar a função library() que procura os 
pacotes instalados.
2) os vetores x e y não tem o mesmo tamanho.
3) existem NAs nos vetores x e/ou y.

Author(s):

Karina Campos Tisovec Dufner
katisovec@gmail.com

References:

Gotelli, Nicholas J.; Ellison, Aaron M. (2004). Regression. In: A primer of ecological 
statistics. p. 240-287. Sinauer Associates. Sunderland, MA, U.S.A. 

Weisstein, Eric W. "Least Squares Fitting." From MathWorld--A Wolfram Web Resource.
http://mathworld.wolfram.com/LeastSquaresFitting.html

Least squares. From Wikipedia, the free encyclopedia.
https://en.wikipedia.org/wiki/Least_squares

Ordinary least squares. From Wikipedia, the free encyclopedia.
https://en.wikipedia.org/wiki/Ordinary_least_squares

See Also:

animation-package, saveGIF(), summary(), lm().

Examples:

## criando os objetos x e y
x= rnorm(100, 10, 1)
y= rnorm(100, 100, 2)

## rodando a função
anim.msd(x, y)

## mudando o limite superior e inferior da gama de inclinações apresentadas
anim.msd(x, y, lim=0.5)
anim.msd(x, y, lim=5)
anim.msd(x, y, lim=20, int=0.5)

## mudando a magnitude da diferença entre uma inclinação e a seguinte
anim.msd(x, y, int=0.01)
anim.msd(x, y, lim=10, int=10)
anim.msd(x, y, lim=10, int=1)

## mudando a velocidade da animação
anim.msd(x, y, time=0.01)
anim.msd(x, y, time=2)

## visualizando a diferença dos resíduos para cada um deles
anim.msd(x, y, cor="ind")

\end{lstlisting}



\end{document}
