Mudanças entre as edições de "R:devtools"

De BrapciWiki
Ir para navegação Ir para pesquisar
(Criou página com 'Biblioteca para criar bibliotecas (pacotes) <h1>Instalando a biblioteca</h1> install.packages("devtools") library("devtools") <h1>Criando um pacote</h1> Antes de criar u...')
 
Linha 11: Linha 11:
 
  setwd("d:/projeto/www/r")
 
  setwd("d:/projeto/www/r")
 
  create("Rthesa")
 
  create("Rthesa")
 +
 +
A função irá criar dois arquivos
 +
- DESCRIPTION
 +
- NAMESPACE
 +
 +
e uma pasta R onde deve ser colocada cada função criada. Deve-se utilizar um arquivo para cada função.
 +
 +
No início de cada arquivo deve-se informar alguns parametros para possibilitar a documentação automática da função
 +
 +
Veja exemplo de uma função:
 +
 +
#' @title StopWords do Thesa
 +
#' @name stopword
 +
#'
 +
#' @description Recupera as stopswords do Thesa
 +
#'
 +
#' @param l linguage do stopword
 +
#'
 +
#' @details Utilize este campo para escrever detalhes mais tecnicos da
 +
#'    sua funcao (se necessario), ou para detalhar melhor como
 +
#'    utilizar determinados argumentos.
 +
#'
 +
#' @return Retorna as StopWords
 +
#'
 +
#' @author Rene Faustino Gabriel Junior
 +
#'
 +
#' @seealso \code{\link[base]{sum}}, \code{\link[base]{+}}
 +
#'
 +
#' @examples
 +
#' stopword("pt")
 +
#'
 +
#' x <- 3
 +
#' y <- 4
 +
#' soma(x = x, y = y)
 +
#'
 +
#' @export
 +
stopword <- function ( lang )
 +
{
 +
    lang = "Portugues"
 +
}

Edição das 19h09min de 2 de junho de 2020

Biblioteca para criar bibliotecas (pacotes)

Instalando a biblioteca

install.packages("devtools")
library("devtools")


Criando um pacote

Antes de criar uma biblioteca, seleciona o pasta de trabalho

setwd("d:/projeto/www/r")
create("Rthesa")

A função irá criar dois arquivos

- DESCRIPTION
- NAMESPACE

e uma pasta R onde deve ser colocada cada função criada. Deve-se utilizar um arquivo para cada função.

No início de cada arquivo deve-se informar alguns parametros para possibilitar a documentação automática da função

Veja exemplo de uma função:

#' @title StopWords do Thesa
#' @name stopword
#'
#' @description Recupera as stopswords do Thesa
#'
#' @param l linguage do stopword
#'
#' @details Utilize este campo para escrever detalhes mais tecnicos da
#'     sua funcao (se necessario), ou para detalhar melhor como
#'     utilizar determinados argumentos.
#'
#' @return Retorna as StopWords
#'
#' @author Rene Faustino Gabriel Junior
#'
#' @seealso \code{\link[base]{sum}}, \code{\link[base]{+}}
#'
#' @examples
#' stopword("pt")
#'
#' x <- 3
#' y <- 4
#' soma(x = x, y = y)
#'
#' @export
stopword <- function ( lang )
{
   lang = "Portugues"
}