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

visualR                package:unknown                R Documentation

Construção de diagramas e mapas conceituais.

Description:

     Esta função permite desenhar diagramas e mapas conceituais de maneira livre (até 200 palavras) ou usando quantidades pré-definidas de palavras. Também permite utilizar um vetor contendo as informações que serão adicionadas ao diagrama. É possível personalizar a fonte do texto, se usará um retângulo ao redor do texto, a cor do retângulo e a cor e o tipo da seta/linha.

Usage:

     visualR (text = NULL, color = "multi", line = 2, words = FALSE, arrows = FALSE, rectangle = TRUE, font = "sans", arrow.col = NULL)
     
Arguments:

 text: permite ao usuário inserir um vetor de valores a serem inseridos no diagrama. Vetores serão convertidos para o tipo character, caso ainda não sejam. Cada valor do vetor não deve possuir mais do que 10 caracteres. Também é necessário que o vetor tenha tamanho maior ou igual a 2.
 
 color: define a cor das linhas e retângulos do diagrama. Tem dois modos para escolha aleatória de cor ("multi" - colorido; "grayscale" - escala de cinza) e permite ao usuário usar a cor que desejar usando o formato RGB ou escrever a cor desejada (ex. "red").
 
 line: define o tipo de linha/seta que será desenhada. Deve ser um número de 1 a 5. Linha 1 - a seta é desenhada com a ponta no ponto inicial. Linha 2 - a seta é desenhada com a ponta no ponto final. Linha 3 - a seta é desenhada com a ponta nos dois pontos. Linha 4 - uma linha é desenhada com bolas nos dois pontos. Linha 5 - uma linha simples é desenhada.
 
 words: permite ao usuário definir quantas palavras deseja escrever, caso não tenha inserido um vetor em text. Quando text está presente, esse argumento é ignorado. words deve ser um número inteiro maior ou igual a 2. Caso words e text não sejam especificados, o usuário terá um limite de 200 palavras para escrever, e poderá parar quando desejar digitando <END>.
 
 arrows: permite ao usuário definir quantas linhas/setas serão desenhadas. Opcional. Caso não seja especificado, o número de linhas/setas será o mesmo do número de palavras. Deve ser um número inteiro maior que 0.
 
 rectangle: permite ao usuário definir se retângulos serão desenhados ou não ao redor das palavras. Por padrão é TRUE, e um retângulo preenchido pela cor escolhida é desenhado.
 
 font: define o tipo de fonte que será usado no diagrama. Por padrão é "sans". A fonte deve ser digitada entre aspas. Consulte o help da função par para mais informações.
 
 arrow.col: permite ao usuário definir uma cor única para as setas/linhas. Nesse caso, a cor deve ser escrita entre aspas (ex. "red") ou em formato RGB.
 

Details:

     Para fazer um diagrama livre de até 200 palavras, usando as configurações padrões, não é necessário inserir nenhum parâmetro.
     Para um diagrama com palavras pré-definidas, basta inserir um vetor no parâmetro text. Caso o vetor não seja do tipo character, o resultado da conversão será exibida ao usuário. Não é necessário inserir o argumento words nesse caso (será ignorado caso inserido), mas o argumento arrows pode ser usado, caso o usuário queira fazer mais conexões entre os textos (uma seta de ida e outra de volta, por exemplo).
     Caso já saiba quantas palavras/informações irá inserir, mas prefira digitar elas uma a uma, é preferível usar o argumento words do que fazer o diagrama livre, uma vez que no primeiro será necessário digitar <END> para finalizar. O mesmo acontece para a inserção de setas, já que no diagrama livre para cada seta inserida é necessário confirmar a continuação.

Value:

     Retorna um diagrama (gráfico) que pode ser salvo usando os códigos padrões para salvar gráficos gerados no R. 

Warning:

     A inserção de um vetor em text de comprimento menor que 2 irá parar a função.
     
     A inserção de um vetor em text em que haja uma palavra com mais de 10 caracteres irá parar a função.
     
     Caso text não esteja presente, inserir um valor em words menor do que 2 irá parar a função. O valor em words também deve ser um número inteiro. Caso contrário, a função irá parar.
     
     Caso arrows seja especificado, deve-se usar um número inteiro maior que 0. Do contrário, a função irá parar.
     
     A geração de cores em "multi" e "grayscale" é aleatória. Dessa forma, combinações desagradáveis podem ser geradas. Caso prefira ter maior controle sobre as cores, prefira especificar uma cor única a usar esses formatos.

    Caso arrow.col não seja especificado, a cor das linhas/setas seguirá as cores estabelecidas para o retângulo de texto. Em alguns casos, isso pode gerar um diagrama confuso.

Author(s):

     Silas C. Principe de Souza
     silasprincipe@usp.br

Examples:

     ##Diagrama livre
     visualR()
     
     ##Diagrama com número de palavras pré definida
     visualR(words = 4)
     
     ##Diagrama com número de palavras e linhas pré definida
     visualR(words = 4, arrows = 2)
     
     ##Usando um vetor de texto e escala de cinza
     saude <- c("peso", "alimento", "saude")
     visualR(text = saude, color = "grayscale")
     
     ##Usando um vetor de texto e cor de seta única
     saude <- c("peso", "alimento", "saude")
     visualR(text = saude, arrow.col = "black")
     
     ##Usando vetor text obtido de um dataset, cor específica, indicação de arrows e linha diferente do padrão
     #Mercedes (240D a 450SL) e rendimento (mpg)
     mercedes <- c(row.names(mtcars[8:13,]),mtcars[8:13,1])
     visualR(text = mercedes, color = rgb(0.2,0.6,0.8,1), arrows = 6, line = 4)
     
     ##Diagrama sem retângulo, cor única, e fonte diferente do padrão
     visualR(rectangle = FALSE, color = "green", font = "serif")

\end{lstlisting}



\end{document}
