Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
josschavezf committed Oct 10, 2024
1 parent c2bbd57 commit e44576a
Show file tree
Hide file tree
Showing 6 changed files with 213 additions and 210 deletions.
11 changes: 5 additions & 6 deletions 02_sesion1.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Este es un título breve pero descriptivo para el paquete.

Todos los paquetes de Bioconductor utilizan un esquema de versión x.y.z. Cuando se envía por primera vez a Bioconductor, un paquete debe tener la versión 0.99.0.

Se aplican las siguientes reglas:
- Se aplican las siguientes reglas:

- x es normalmente 0 para paquetes que aún no han sido liberados.
- y es par para paquetes liberados, e impar para paquetes en desarrollo. Generalmente, no se debe aumentar este número en el pre-release.
Expand Down Expand Up @@ -181,14 +181,13 @@ Para paquetes que incluyen datos, se recomienda NO incluir LazyData: TRUE. Inclu

Todos los paquetes deben estar disponibles a través de biocViews o CRAN de Bioconductor; el uso del campo Remotes: no es soportado, por lo tanto las dependencias sólo disponibles en otros repositorios (e.g. GitHub) no están permitidas.

Un paquete puede ser listado sólo una vez entre Depends, Imports, Suggests, o Enhances.

- Un paquete puede ser listado sólo una vez entre Depends, Imports, Suggests, o Enhances:

- Imports: es para paquetes que proporcionan funciones, métodos o clases que se usan dentro del código del paquete. La mayoría de los paquetes están listados aquí.

- Depends: es para paquetes que proporcionan funcionalidad esencial para los usuarios del paquete, por ejemplo, el paquete GenomicRanges se enumera en el campo Depends: de GenomicAlignments. Es poco común que más de tres paquetes aparezcan como Depends:.

- Suggests: es para paquetes usados en viñetas, ejemplos y código condicional. Comúnmente, los paquetes de anotaciones y experimentos (por ejemplo, TxDb*) usados en viñetas y código de ejemplo se incluyen en este campo, evitando así una descarga costosa.
- Enhances: es para paquetes como parallel que mejoran el rendimiento del paquete, pero no son estrictamente necesarios para su funcionalidad.


En el caso de que se requiera una función única externa para el código del paquete, la disponibilidad y el uso del paquete pueden hacerse a través de:

Expand All @@ -198,7 +197,7 @@ if (!requireNamespace('suggPKG', quietly = TRUE))
suggPKG::function()
```

- Enhances: es para paquetes como parallel que mejoran el rendimiento del paquete, pero no son estrictamente necesarios para su funcionalidad.


- biocViews

Expand Down
28 changes: 14 additions & 14 deletions docs/compilación-e-instalación-de-paquetes.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,9 +304,9 @@ <h2><span class="header-section-number">9.2</span> Metadatos de una paquetería<
<h3><span class="header-section-number">9.2.1</span> Description<a href="compilación-e-instalación-de-paquetes.html#description" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>El campo Description describe lo que hace tu paquetería. Suele ser extenso, si requieres escribir múltiples líneas, deben estar indentadas.</p>
<p>Por ejemplo:</p>
<div class="sourceCode" id="cb61"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb61-1"><a href="compilación-e-instalación-de-paquetes.html#cb61-1" tabindex="-1"></a><span class="co"># Description: Este paquete contiene todas las funciones generadas en el curso </span></span>
<span id="cb61-2"><a href="compilación-e-instalación-de-paquetes.html#cb61-2" tabindex="-1"></a><span class="co"># de escritura de paqueterías en R. También contiene las funciones que cada </span></span>
<span id="cb61-3"><a href="compilación-e-instalación-de-paquetes.html#cb61-3" tabindex="-1"></a><span class="co"># participante propuso para solucionar un problema relacionado con su trabajo.</span></span></code></pre></div>
<div class="sourceCode" id="cb58"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb58-1"><a href="compilación-e-instalación-de-paquetes.html#cb58-1" tabindex="-1"></a><span class="co"># Description: Este paquete contiene todas las funciones generadas en el curso </span></span>
<span id="cb58-2"><a href="compilación-e-instalación-de-paquetes.html#cb58-2" tabindex="-1"></a><span class="co"># de escritura de paqueterías en R. También contiene las funciones que cada </span></span>
<span id="cb58-3"><a href="compilación-e-instalación-de-paquetes.html#cb58-3" tabindex="-1"></a><span class="co"># participante propuso para solucionar un problema relacionado con su trabajo.</span></span></code></pre></div>
</div>
<div id="dependencias" class="section level3 hasAnchor" number="9.2.2">
<h3><span class="header-section-number">9.2.2</span> Dependencias<a href="compilación-e-instalación-de-paquetes.html#dependencias" class="anchor-section" aria-label="Anchor link to header"></a></h3>
Expand All @@ -323,14 +323,14 @@ <h3><span class="header-section-number">9.2.2</span> Dependencias<a href="compil
<p><strong>Nota Importante</strong></p>
<p>Se recomienda listar los paquetes necesarios para el funcionamiento de nuestro paquete en <em>Imports</em> porque cuando se ponen en <em>Depends</em> se cargan los paquetes completos y probablemente solamente requerimos una o dos funciones.</p>
<p>Cargar demasiados paquetes completos, sin ser necesario, sólo hace que nuestro paquete se vuelva pesado y lento. Es mejor llamar particularmente a las funciones usando la sintaxis explícita:</p>
<div class="sourceCode" id="cb62"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb62-1"><a href="compilación-e-instalación-de-paquetes.html#cb62-1" tabindex="-1"></a>Biostrings<span class="sc">::</span><span class="fu">translate</span>()</span></code></pre></div>
<div class="sourceCode" id="cb59"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb59-1"><a href="compilación-e-instalación-de-paquetes.html#cb59-1" tabindex="-1"></a>Biostrings<span class="sc">::</span><span class="fu">translate</span>()</span></code></pre></div>
</div>
<div id="cómo-añadir-dependencias" class="section level3 hasAnchor" number="9.2.3">
<h3><span class="header-section-number">9.2.3</span> ¿Cómo añadir dependencias?<a href="compilación-e-instalación-de-paquetes.html#cómo-añadir-dependencias" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<ul>
<li>Usando usethis:</li>
</ul>
<div class="sourceCode" id="cb63"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb63-1"><a href="compilación-e-instalación-de-paquetes.html#cb63-1" tabindex="-1"></a>usethis<span class="sc">::</span><span class="fu">use_package</span>(<span class="st">&quot;ggplot2&quot;</span>, <span class="at">type =</span> <span class="st">&quot;Imports&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb60"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb60-1"><a href="compilación-e-instalación-de-paquetes.html#cb60-1" tabindex="-1"></a>usethis<span class="sc">::</span><span class="fu">use_package</span>(<span class="st">&quot;ggplot2&quot;</span>, <span class="at">type =</span> <span class="st">&quot;Imports&quot;</span>)</span></code></pre></div>
<ul>
<li>Editando manualmente el archivo DESCRIPTION.</li>
</ul>
Expand Down Expand Up @@ -374,22 +374,22 @@ <h2><span class="header-section-number">9.6</span> Instalando la última versió
<ul>
<li>Si el paquete se encuentra depositado en CRAN podemos usar la función</li>
</ul>
<div class="sourceCode" id="cb64"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb64-1"><a href="compilación-e-instalación-de-paquetes.html#cb64-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_dev</span>(<span class="st">&quot;pkgname&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb61"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb61-1"><a href="compilación-e-instalación-de-paquetes.html#cb61-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_dev</span>(<span class="st">&quot;pkgname&quot;</span>)</span></code></pre></div>
<p>Por ejemplo, para instalar la versión en desarrollo de dplyr usaremos el comando</p>
<div class="sourceCode" id="cb65"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb65-1"><a href="compilación-e-instalación-de-paquetes.html#cb65-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_dev</span>(<span class="st">&quot;dplyr&quot;</span>) </span></code></pre></div>
<div class="sourceCode" id="cb62"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb62-1"><a href="compilación-e-instalación-de-paquetes.html#cb62-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_dev</span>(<span class="st">&quot;dplyr&quot;</span>) </span></code></pre></div>
<ul>
<li>Si el paquete se encuentra en Bioconductor usaremos la siguiente función:</li>
</ul>
<div class="sourceCode" id="cb66"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb66-1"><a href="compilación-e-instalación-de-paquetes.html#cb66-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_bioc</span>(<span class="st">&quot;pkgname&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb63"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb63-1"><a href="compilación-e-instalación-de-paquetes.html#cb63-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_bioc</span>(<span class="st">&quot;pkgname&quot;</span>)</span></code></pre></div>
<p>Por ejemplo, para instalar la versión en desarrollo de regutools, el paquete desarrollado por miembros de la CDSB, usaremos el comando</p>
<div class="sourceCode" id="cb67"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb67-1"><a href="compilación-e-instalación-de-paquetes.html#cb67-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_bioc</span>(<span class="st">&quot;regutools&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb64"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb64-1"><a href="compilación-e-instalación-de-paquetes.html#cb64-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_bioc</span>(<span class="st">&quot;regutools&quot;</span>)</span></code></pre></div>
</div>
<div id="instalando-paquetes-desde-github" class="section level2 hasAnchor" number="9.7">
<h2><span class="header-section-number">9.7</span> Instalando paquetes desde GitHub<a href="compilación-e-instalación-de-paquetes.html#instalando-paquetes-desde-github" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>Para poder instalar un paquete desde GitHub necesitaremos conocer el usuario del creador y el nombre del repositorio.</p>
<div class="sourceCode" id="cb68"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb68-1"><a href="compilación-e-instalación-de-paquetes.html#cb68-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;usuario/repositorio&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb65"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb65-1"><a href="compilación-e-instalación-de-paquetes.html#cb65-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;usuario/repositorio&quot;</span>)</span></code></pre></div>
<p>Por ejemplo, para instalar el paquete starwarssay desarrollado por Erick Cuevas (Erickcufe) utilizaremos el siguiente comando:</p>
<div class="sourceCode" id="cb69"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb69-1"><a href="compilación-e-instalación-de-paquetes.html#cb69-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;Erickcufe/starwarssay&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb66"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb66-1"><a href="compilación-e-instalación-de-paquetes.html#cb66-1" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;Erickcufe/starwarssay&quot;</span>)</span></code></pre></div>
<p>Independientemente de si el paquete se encuentra en CRAN, Bioconductor, o ninguno de ellos, podemos instalar un paquete depositado en una cuenta de GitHub.</p>
<p>Para poder instalar un paquete desde GitHub necesitaremos conocer el usuario del creador y el nombre del repositorio donde se encuentra depositado el paquete. Con esta información usaremos la siguiente función:</p>
</div>
Expand All @@ -399,15 +399,15 @@ <h2><span class="header-section-number">9.8</span> Instalando un paquete local<a
<li><p>Paso 1: Abre el proyecto del paquete que estás desarrollando.</p></li>
<li><p>Paso opcional: Ejecuta la documentación si realizaste algún cambio.</p></li>
</ul>
<div class="sourceCode" id="cb70"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb70-1"><a href="compilación-e-instalación-de-paquetes.html#cb70-1" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">document</span>()</span></code></pre></div>
<div class="sourceCode" id="cb67"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb67-1"><a href="compilación-e-instalación-de-paquetes.html#cb67-1" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">document</span>()</span></code></pre></div>
<ul>
<li>Paso 2: Construye el paquete:</li>
</ul>
<div class="sourceCode" id="cb71"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb71-1"><a href="compilación-e-instalación-de-paquetes.html#cb71-1" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">build</span>()</span></code></pre></div>
<div class="sourceCode" id="cb68"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb68-1"><a href="compilación-e-instalación-de-paquetes.html#cb68-1" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">build</span>()</span></code></pre></div>
<ul>
<li>Paso 3: Instala el paquete desde tu proyecto actual:</li>
</ul>
<div class="sourceCode" id="cb72"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb72-1"><a href="compilación-e-instalación-de-paquetes.html#cb72-1" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">install</span>()</span></code></pre></div>
<div class="sourceCode" id="cb69"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb69-1"><a href="compilación-e-instalación-de-paquetes.html#cb69-1" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">install</span>()</span></code></pre></div>
</div>
<div id="contribuyendo-código" class="section level2 hasAnchor" number="9.9">
<h2><span class="header-section-number">9.9</span> Contribuyendo código<a href="compilación-e-instalación-de-paquetes.html#contribuyendo-código" class="anchor-section" aria-label="Anchor link to header"></a></h2>
Expand Down
6 changes: 3 additions & 3 deletions docs/creación-de-viñetas.html
Original file line number Diff line number Diff line change
Expand Up @@ -314,11 +314,11 @@ <h2><span class="header-section-number">8.3</span> Características de una vigne
</div>
<div id="cómo-consultar-la-viñeta-de-un-paquete" class="section level2 hasAnchor" number="8.4">
<h2><span class="header-section-number">8.4</span> ¿Cómo consultar la viñeta de un paquete?<a href="creación-de-viñetas.html#cómo-consultar-la-viñeta-de-un-paquete" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<div class="sourceCode" id="cb58"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb58-1"><a href="creación-de-viñetas.html#cb58-1" tabindex="-1"></a><span class="fu">browseVignettes</span>(<span class="at">package =</span> <span class="st">&quot;ggplot2&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb55"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb55-1"><a href="creación-de-viñetas.html#cb55-1" tabindex="-1"></a><span class="fu">browseVignettes</span>(<span class="at">package =</span> <span class="st">&quot;ggplot2&quot;</span>)</span></code></pre></div>
</div>
<div id="cómo-crear-una-viñeta" class="section level2 hasAnchor" number="8.5">
<h2><span class="header-section-number">8.5</span> ¿Cómo crear una viñeta?<a href="creación-de-viñetas.html#cómo-crear-una-viñeta" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<div class="sourceCode" id="cb59"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb59-1"><a href="creación-de-viñetas.html#cb59-1" tabindex="-1"></a>biocthis<span class="sc">::</span><span class="fu">use_bioc_vignette</span>(<span class="st">&quot;mi_vignette&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb56"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb56-1"><a href="creación-de-viñetas.html#cb56-1" tabindex="-1"></a>biocthis<span class="sc">::</span><span class="fu">use_bioc_vignette</span>(<span class="st">&quot;mi_vignette&quot;</span>)</span></code></pre></div>
<p>Esta función tendrá tres efectos:</p>
<ul>
<li>Generar el directorio vignettes en caso que no exista.</li>
Expand All @@ -329,7 +329,7 @@ <h2><span class="header-section-number">8.5</span> ¿Cómo crear una viñeta?<a
<div id="cómo-guardar-y-actualizar-la-viñeta" class="section level2 hasAnchor" number="8.6">
<h2><span class="header-section-number">8.6</span> ¿Cómo guardar y actualizar la viñeta?<a href="creación-de-viñetas.html#cómo-guardar-y-actualizar-la-viñeta" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>Una vez que se ha generado el archivo vignettes/mi_vignette.Rmd se hacen las modificaciones necesarias. Puedes usar el comando:</p>
<div class="sourceCode" id="cb60"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb60-1"><a href="creación-de-viñetas.html#cb60-1" tabindex="-1"></a><span class="fu">edit_file</span>(<span class="st">&quot;vignettes/mi_vignette.Rmd&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb57"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb57-1"><a href="creación-de-viñetas.html#cb57-1" tabindex="-1"></a><span class="fu">edit_file</span>(<span class="st">&quot;vignettes/mi_vignette.Rmd&quot;</span>)</span></code></pre></div>
<p>Para guardar los cambios debes hacer click en el botón Knit o utiliza la combinación de teclas Ctrl/Cmd-Shift-K.</p>
</div>
<div id="veamos-un-ejemplo" class="section level2 hasAnchor" number="8.7">
Expand Down
Loading

0 comments on commit e44576a

Please sign in to comment.