Documentación de funciones

En esta seccion solo hablaremos sobre su documentacion, sin embargo si te interesa conocer mas sobre como se generan las funciones, puedes ver el material sobre El ABC de las funciones y loops en R en los VieRnes de Bioinformática.

Ejemplo

Synthesize image files for testing circularity estimation algorithm.

Usage: make_images.py -f fuzzing -n flaws -o output -s seed -v -w size

where:
-f fuzzing = fuzzing range of blobs (typically 0.0-0.2)
-n flaws   = p(success) for geometric distribution of # flaws/sample (e.g. 0.5-0.8)
-o output  = name of output file
-s seed    = random number generator seed (large integer)
-v         = verbose
-w size    = image width/height in pixels (typically 480-800)
-h = show help message

Cuando ya vayamos a crear un paquete podemos usar roxygen2 para la documentacion de las funciones.

Yo uso el ejemplo de la funcion sum().

Good Enough Practices for Scientific Computing

Ejemplo de como realizo mis documentos 💜

Aqui les dejo el script que les doy a mis alumnos VisualizacionDatos.R del curso de Análisis de datos de RNA-Seq.

Paquete roxygen2

Ejemplo:

El software detecta la informacion que esta posterior al #'.

# install.packages("docstring")
library(docstring)
# install.packages("roxygen2")
library(roxygen2)

#' @title Multiply two numbers
#' @description This function takes two
#' input numbers and multiplies
#' them. It returns the multiplied result.
#' 
#' @param x The first value
#' @param y The second value
#' @return The two arguments multiplied.

multiply <- function(x,y){
  return(x*y)
}

Ejercicio tomado de aqui. Documentacion docstring.

NOTA: Ahora que ya se instalo el paquete se activa una nueva funcion en Code/Insert Roxygen Skeleton.