\documentclass[a4paper, oneside, 10pt]{article}
\usepackage[unicode]{hyperref}
\usepackage[utf8x]{inputenc}
\usepackage[english]{babel}
\usepackage{listings}
\date{\today}
\title{}
\author{}
\begin{document}



\subsection{\texorpdfstring{Help}{Help}}
\label{sec:help}
\lstset{frame=single}
\begin{lstlisting}

lista_compras                package:unknown                R Documentation

CRIA LISTA DE COMPRAS A PARTIR DE RECEITAS ESCOLHIDAS DE UM CATÁLOGO

Description:

     Dado um número de refeições e seu tipo (refeição principal, café, ou pé na jaca), a função monta
uma lista de supermercado com os ingredientes necessários para preparar as receitas que são sorteadas
de um catálogo de receitas oferecido. A função permite o preparo de uma refeição principal para mais
de uma pessoa, e aceita uma lista de ingredientes já disponíveis, preferenciando receitas que contenham
esses ingredientes. A função devolve a lista de compras do supermercado, as receitas escolhidas, e caso
não seja possível usar todos ingredientes da lista oferecida, uma lista de itens não utilizados.

Usage:

     lista_compras = function(cafe, refeicao, jaca, multiplos = 0, listasobras = NULL, listacafe, listarefeicao, listajaca)

Arguments:

 cafe           número de receitas do tipo café desejadas
 refeicao       número de receitas do tipo refeição principal desejadas
 jaca           número de receitas do tipo pé na jaca desejadas
 multiplos      número de pessoas que irão comer na refeição principal múltipla (servida para mais de uma pessoa). Default = 0
 listasobras    um dataframe de 3 colunas, sendo elas ingrediente (chr), quantidade (num) e unidade de medida (chr). Default = NULL
 listacafe      um dataframe de 5 colunas, sendo elas receita (chr), ingrediente (chr), quantidade (num), unidade de medida (chr) e intruções (chr)
 listarefeicao  um dataframe de 5 colunas, sendo elas receita (chr), ingrediente (chr), quantidade (num), unidade de medida (chr) e intruções (chr)
 listajaca      um dataframe de 5 colunas, sendo elas receita (chr), ingrediente (chr), quantidade (num), unidade de medida (chr) e intruções (chr)


Details:

     A montagem dos dataframes para listacafe, listarefeicao e listajaca deve ser a seguinte:
        Nunca usar strings como fatores
        número de linhas variável
        número de colunas = 5
            coluna 1 = RECEITA = character
            coluna 2 = INGREDIENTE = character
            coluna 3 = QUANTIDADE = numeric
            coluna 4 = UNIDADE DE MEDIDA = character
            coluna 5 = INSTRUCOES = character

    A montagem do dataframe para listasobras deve ser a seguinte:
        Nunca usar strings como fatores
        número de linhas variável
        número de colunas = 3
            coluna 1 = INGREDIENTE = character
            coluna 2 = QUANTIDADE = numeric
            coluna 3 = UNIDADE DE MEDIDA = character

Value:

  lista_receita : dataframe contendo 2 colunas: o nome e as instruções para cada uma das receitas usadas para montar a lista de compras

  lista_supermercado : dataframe contendo 3 colunas: o nome do ingrediente, a quantidade e a unidade de medida de cada um dos ingredientes necessários para as receitas escolhidas

  lista_nao_usado : caso tenha sido passado o argumento listasobras, e nem todos itens nessa lista tenham sido usados nas receitas, esse dataframe apresenta os ingredientes que não serão usados, na estrutura de 3 colunas: nome do ingrediente, quantidade e unidade de medida


Warning:

     O formato dos dataframes passados como listasobras, listacafe, listarefeicao e listajaca são
muito importantes, então cuidado com a montagem deles. Por exemplo, sempre verificar que as colunas
não estão interpretadas como fatores. Além disso, um mesmo ingrediente deve sempre estar expresso com
a mesma unidade de medida em todos os lugares em que ele aparece. Caso isso não ocorra, a função
executa um erro avisando que este foi o problema.


Author(s):

     Maira Neves
     maira.rn@gmail.com
     maira.neves@usp.br


Examples:

     exemplo_cafe = read.csv("cafe.csv", sep=';', stringsAsFactors = FALSE)
     exemplo_refeicao = read.csv("refeicao.csv", sep=';', stringsAsFactors = FALSE)
     exemplo_jaca = read.csv("jaca.csv", sep=';', stringsAsFactors = FALSE)
     lista_compras(cafe = 2, refeicao = 3, jaca = 1, listacafe = exemplo_cafe, 
                listarefeicao = exemplo_refeicao, listajaca = exemplo_jaca,)


     exemplo_cafe = read.csv("cafe.csv", sep=';', stringsAsFactors = FALSE)
     exemplo_refeicao = read.csv("refeicao.csv", sep=';', stringsAsFactors = FALSE)
     exemplo_jaca = read.csv("jaca.csv", sep=';', stringsAsFactors = FALSE)
     itens_sobra = c("Ovos", "Leite", "Cenoura", "Beterraba")
     qtdd_sobra = c(3, 250, 1, 3)
     medida_sobra = c("unidade", "mililitros", "unidade", "unidade")
     exemplo_sobras = data.frame(itens_sobra, qtdd_sobra, medida_sobra, stringsAsFactors = FALSE)
     lista_compras(cafe = 3, refeicao = 2, jaca = 0, listacafe = exemplo_cafe, 
              listarefeicao = exemplo_refeicao, listajaca = exemplo_jaca,
              listasobras = exemplo_sobras)

\end{lstlisting}



\end{document}
