Primeros pasos: Creación del paquete

#

1. Revisar si podemos usar el nombre del paquete

available::available("mipaquete"

2. Crear la estructura inicial del paquete

usethis::create_package("mipaquete")

3. Podemos agregar la estructura de biocthis

biocthis::use_bioc_pkg_templates()

4. Pedir que Git ignore el archivo .Rproj

usethis::use_git_ignore("*.Rproj")

5. Crear el respositorio de GitHub

usethis::use_github()

6. Crear el archivo Description estilo Bioconductor

biocthis::use_bioc_description()

7. Crear el archivo README estilo Bioconductor

biocthis::use_bioc_readme_rmd()
devtools::build_readme()

👀 Recuerda guardar los cambios, hacer commit y push. 8. Crear el archivo NEWS estilo Bioconductor

biocthis::use_bioc_news_md()

9. Crear los archivos de ayuda para usuarios y contribuidores

biocthis::use_bioc_coc()
usethis::use_tidy_contributing()
biocthis::use_bioc_support()
biocthis::use_bioc_issue_template()
biocthis::use_bioc_citation()

Buenas prácticas para la construcción de funciones 🐈

#

Nombre de la función

#

Al momento de nombrar la función, asegurate de que cumplan estas características

• Que sea corto y descriptivo
• Separar las palabras con un _
• Establecer una palabra en común al inicio para familias de funciones

Es mejor usar

use_bioc_citation()

que lo siguiente:

citation()
bioc_cit()
usebioccitation()
useBiocCitation()
use.bioc.citation()

Estructura de la función

#

Puntos a tenere en cuenta:

• Identar las líneas de código
• Agregar comentarios para separar/describir las secciones importantes.
• Usar la sintaxis paquete::funcion() cuando hacemos llamado a funciones de otros paquetes. Ejemplo:

  usethis::use_r("subset_heatmap")
  

Ejemplo practico 🐣

#