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

monitoraR                      package:unknown                          R Documentation

FUNÇÃO PARA SIMULAÇÃO DAS CONDIÇÕES DE ONDA, ESTÁGIO PRAIAL E RISCO DE CORRENTE DE RETORNO
  
Description:

  A função calcula a altura média de onda, período médio de onda, estágio praial e risco de corrente de retorno para uma praia no litoral brasileiro. 
  A partir dos argumentos de entrada, a função faz o download da saída do modelo Wave Watch III. 
  Utilizando altura de onda em água profunda e período de onda obtidos pela saída de modelo, são calculados os demais parâmetros bem como gerado gráfico da evolução dos valores do estágio de praia e risco de corrente de retorno a cada dia do intervalo amostrado. 
  
Usage:
  
  monitoraR (lat, long, dia.inicio, dia.final, destfile, graph = TRUE) 
  
Arguments:
 
  lat: número indicando o valor de latitude (em graus decimais) da praia de interesse. O mesmo deve variar de 3 a -34, que corresponde ao litoral brasileiro (class: numeric).
  

  long: número menor que zero (lado oeste do globo) (class: numeric)
  

  dia.inicio: data correspondente ao dia do início da simulação (recomendado usar data do dia presente) no formato YYYY-MM-DD (class: caracter)
  

  dia.final: data correspondente ao dia do final da simulação que deve ser no máximo 6 dias depois da data de início (recomendado usar 6 dias depois da data do dia presente) no formato YYYY-MM-DD (class: caracter)
  
  
  destfile: diretório e nome do arquivo (.csv) no qual será salvo a saída do modelo WaveWatch III. Exemplo: “~diretório-trabalho/nome-arquivo.csv" (dica: para escrever corretamente a pasta do diretório, escolher o mesmo e copiar como aparece no console)
    
  graph: geração do gráfico das características da praia (estágio praial e risco de corrente de retorno) em cada dia do intervalo escolhido. Caso graph=TRUE será gerado o gráfico, do contrário não. 
  
  
Details:
  
  Para que a função seja executada de forma correta, é necessário escolher, digitando no console do R, em qual dos 17 brasileiros está localizado a praia e qual a característica do grão da praia escolhida conforme opções fornecidas (atentar para letras maiúsculas e minúsculas). Praias cuja principal forçante da dinâmica seja a maré (RTR>10) não são contempladas pela função proposta. O cálculo do fator de risco de corrente de retorno foi adaptado de Engels et al. (2002) levando em consideração amplitude de maré, altura de onda em água rasa e período de onda. Caso deseje que seja gerado o gráfico (graph=T), aparecerá no console a mensagem para clicar em algum local do gráfico para posicionar a legenda. 
  
Value:

    * Gráfico de linhas com os valores do estágio praial e risco de corrente de retorno em cada dia do intervalo escolhido para a praia de interesse.
  
    *  Lista:
  
Comp1: altura média de onda em água rasa por dia, no qual cada posição corresponde aos dias do intervalo (primeira posição ao primeiro dia, sucessivamente)
Comp2: período médio de onda por dia, no qual cada posição corresponde aos dias do intervalo (primeira posição ao primeiro dia, sucessivamente)
Comp3: valor do estágio praial calculado através das médias diárias de altura de onda em água rasa e período de onda, conforme equção descrita em Wright and Short (1984). Cada posição corresponde aos dias do intervalo (primeira posição ao primeiro dia, sucessivamente)
Comp4: nome correspondente a cada estágio praial calculado. 
Comp5: fator de risco de ocorrência de corrente de retorno adaptado de Engels et al. (2002), baseado em altura de onda, amplitude de maré e período de onda. 
  
Warning:
  
  Se algum dos argumentos for inserido incorretamente, a função não é executada.
  
  A função retorna valores estimados através de cálculos que contém aproximações e saídas do modelo WaveWatch III, logo, podem não corresponder às condições observadas in situ na praia. 

Author(s):
  
  Mariana Santos Lobato Martins
  e-mail: mlobatomartins@gmail.com
  
References:
  
  https://coastwatch.pfeg.noaa.gov/erddap/griddap/NWW3_Global_Best.html
  CALLIARI, L.J., MUEHE, D., HOEFEL, F.G.& TOLDO JR., E. Morfodinâmica praial: uma breve revisão. Rev. Bras. Oceanogr., 51:63-78, 2003. 
  ENGLE, J., MacMAHAN, J., THIEKE, R.J., HANES, D.M., DEAN, R.G. Formulation of a Rip Current Predictive Index using Rescue Data. Proc. National Conf. on Beach Preservation Technology, 23-25, 2002. 


Examples:
  
  **Alterar sempre o destfile do exemplo** com o diretório de trabalho e nome do arquivo a ser salvo (.csv). 
  
  monitoraR (lat = -33.5, long = -53.3, dia.inicio = “2019-06-25", dia.final = “2019-07-01", destfile = “~diretorio-trabalho/nome-arquivo.csv", graph = TRUE)
#obs! Praia do Chuí: inserir os seguintes parâmetros direto no console quando pedido - Estado = RS e característica do grão = AreiaF
  
  monitoraR (-3.03, -39.88, dia.inicio = “2019-06-25", dia.final = “2019-07-01", destfile = “~diretorio-trabalho/nome-arquivo.csv", graph = TRUE)
#obs! Praia da Almofala: inserir os seguintes parâmetros direto no console quando pedido - Estado = CE e característica do grão = AreiaM
  
  monitorar(-23.99, -46.41, dia.inicio = “2019-06-29", dia.final = “2019-07-04", destfile = “~diretorio-trabalho/nome-arquivo.csv", graph = TRUE
#obs! Praia Grande: inserir os seguintes parâmetros direto no console quando pedido - Estado = SP e característica do grão = AreiaM

\end{lstlisting}



\end{document}
