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

\lstset{frame=single}
\begin{lstlisting}

mares                          package:unknown                          R Documentation

BUSCA DE TABELAS DE MARÉS   


Description:
 
  Função para buscar tabelas de marés com localidade, altura de marés e períodos específicos. A função tem disponibilidade de busca para 28 localidades para o ano de 2018, baseadas nas tábuas de marés disponibilizadas pela Marinha do Brasil em seu website https://www.marinha.mil.br/chm/tabuas-de-mare. 
  

Usage:
  
  mares (localidade, periodo, mare)
    

Arguments:
 
Localidade = localidade a ser utilizada para buscas. As localidades disponíveis são: Belém [PA] ("BELEM", "belem", "Belem", "bel"), Cabedelo [PB] ("CABEDELO", "cabedelo", "Cabedelo", "cab), Paranaguá [PR] ("PARANAGUA", "paranagua", "Paranagua", "paran"), Porto de Suape [PE] ("SUAPE", "suape", "Suape", "sua"), Recife [PE] ("RECIFE", "recife", "Recife", "rec"), Fernando de Noronha [PE] ("NORONHA", "F.noronha", "noronha", "f.nor"), Luís Correia [PI] ("LUIS.CORREIA", "luis.correia","Luis.Correia", "l.correia"), Ilha Fiscal do Rio de Janeiro [RJ] ("ILHA.FISCAL", "ilha.fiscal", "Ilha.Fiscal", "i.fiscal"), Angra dos Reis [RJ] ("ANGRA", "angra", "Angra",  "angra.reis"), Macaé [RJ] ("IMBETIBA", "imbetiba", "Imbetiba", "Imbet"), Natal [RN] ("NATAL", "natal", "Natal", "nat"), Areia Branca [RN] (,"AREIA.BRANCA", "areia.branca", "Areia.Branca", "a.branca"),Maceio [AL] ("MACEIO", "maceio", "Maceio", "mac"), Porto de Rio Grande [RS] ("RIO.GRANDE", "rio.grande", "Rio.Grande", "r.grande"), Florianopolis [SC] ("FLORIANOPOLIS", "florianopolis", "Florianopolis", "floripa"), Itajaí [SC] ("ITAJAI", "itajai", "Itajai", "itaj"), Santos [SP] ("SANTOS", "santos", "Santos", "sant"), São Sebastião [SP] ("SAO.SEBASTIAO", "sao.sebastiao", "Sao.Sebastiao", "s.sebastiao"), Maceió [SE] ("SERGIPE", "sergipe", "Sergipe", "serg"), Santana [AP] ("SANTANA", "santana", "Santana", "sant"), Salvador [BA] ("SALVADOR", "salvador", "Salvador", "salv"), Ilhéus [BA] ("ILHEUS", "ilheus", "Ilheus", "ilh"), Fortaleza [CE] ("MUCURIPE", "mucuripe", "Mucuripe", "muc"), Pecém [CE] ("PECEM", "pecem", "Pecem", "pec"), Vitória [ES] ("VITORIA", "vitoria", "Vitoria", "vit"), Anchieta [ES] ("UBU", "ubu", "Ubu"), São Luís [MA] ("SAO.LUIS", "sao.luis", "Sao.Luis", "s.luis") e Trindade [ES] ("TRINDADE", "trindade", "trind").  


período = período do ano para o qual deseja a busca. Os períodos disponíveis são semestre ("sem.1", "sem.2"), trimestre ("tri.1", "tri.2", "tri.3", "tri.4") ou mês ("jan", "fev", "mar", "abr", "jun", "jul", "ago", "set", "out", "nov", "dez").


mare = altura de maré para a qual se deseja a busca, esse argumento é opcional. As alturas de maré disponíveis são as alturas ocorrentes no Brasil ("-0.2","-0.1","0.0","0.1", "0.2", "0.3", "0.4", "0.5", "0.6", "0.7", "0.8", "0.9","1.0","1.1","1.2","1.3","1.4","1.5","1.6","1.7","1.8","1.9", "1.9", "2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "2.8", "2.9", "3.0", "3.1", "3.2", "3.3", "3.4", "3.5", "3.6", "3.7", "3.8", "3.9", "4.0", "4.1", "4.2", "4.3", "4.4", "4.5", "4.6", "4.7", "4.8", "4.9", "5.0", "5.1", "5.2", "5.3", "5.4", "5.5", "5.6", "5.7", "5.8", "5.9", "6.0", "6.1", "6.2", "6.3", "6.4", "6.5") 
  


Details:

 Para o correto funcionamento desta função o usuário deve possuir instalados os pacotes pdf_tools e tidyr que serão carregados automaticamente pela função.

 Todos os argumentos devem ser fornecidos entre aspas, mesmo os valores de altura de maré, pois precisam ser lidos como caracteres. 

  Os argumentos localidade e periodo são obrigatórios, já o argumento mare é opcional, quando não utilizado a função busca por marés de altura 0.3, a altura média de maré utilizada para planejamentos de coletas de animais marinhos na zona entre marés. 

 O dataframe final pode possuir NAs devido a necessidade de se ter o mesmo número de linhas para todas as colunas. Além disso, os resultados apresentados incluem outras alturas de maré além da especificada. Isso ocorre devido ao formato dos dados importados de pdf.
  


Value:

 O resultado da função é um dataframe com datas e horários da maré estabelecida. Este dataframe é retornado na tela e salvo no diretório de trabalho corrente como um documento .csv separado por ponto e vírgula. 
Além disso, o pdf da tábua de marés anual correspondente à localidade solicitada é salvo no diretório de trabalho corrente.



Warning:

 Se algum dos argumentos não for inserido corretamente, a função é interrompida e uma mensagem especificando o argumento problemático é apresentada.   

 A conexão à internet é necessária para funcionamento correto da função, uma vez que será realizado o download da tábua de marés correspondente à localidade solicitada.
Alturas de maré superiores a 2.0 só estão disponíveis para algumas localidades, uma vez que são marés anômalas para a maior parte da costa brasileira.


Author(s):

    Cecili Barrozo Mendes

  e-mail: cecilimendes@gmail.com



References:

  https://cran.r-project.org/web/packages/pdftools/index.html
  https://ropensci.org/blog/2016/03/01/pdftools-and-jeroen/
  https://cran.r-project.org/web/packages/tidyr/index.html
  http://blog.rstudio.com/2014/07/22/introducing-tidyr/



Examples:

 mares(localidade = "pecem", period = "jan", mare = "-0.1")

 mares(localidade = "serg", period = "tri.1", mare = "1.8")

 mares(localidade = "santos", periodo = "sem.2", mare = "1.5")

 mares(localidade = "Imbetiba", periodo = "fev")
\end{lstlisting}



\end{document}
