Skip to content

Commit 99164a5

Browse files
committed
Deploying to gh-pages from @ 9d81666 🚀
1 parent 061c3eb commit 99164a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+454
-137
lines changed

404.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<meta name="author" content="Daniela Cassol">
1010
<meta name="author" content="Johannes Rainer">
1111
<meta name="author" content="Lori Shepherd">
12+
<meta name="author" content="Marcel Ramos Pérez">
13+
<meta name="author" content="Martin Morgan">
1214
<meta name="description" content="The page you requested cannot be found (perhaps it was moved or renamed). You may want to try searching to find the page's new location, or use the table of contents to find the page you are...">
1315
<meta name="generator" content="bookdown 0.43 with bs4_book()">
1416
<meta property="og:title" content="Page not found | Bioconductor Packages: Development, Maintenance, and Peer Review">
@@ -116,6 +118,7 @@ <h1>
116118
<li><a class="" href="cmavericks-best-practices.html"><span class="header-section-number">E</span> C++/Mavericks Best Practices</a></li>
117119
<li><a class="" href="man-links.html"><span class="header-section-number">F</span> Debug: Links in Rd files</a></li>
118120
<li><a class="" href="booknews.html"><span class="header-section-number">G</span> NEWS</a></li>
121+
<li><a class="" href="references-1.html"><span class="header-section-number">H</span> References</a></li>
119122
</ul>
120123

121124
<div class="book-extra">
@@ -142,7 +145,7 @@ <h1>Page not found<a class="anchor" aria-label="anchor" href="#page-not-found"><
142145
<footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
143146

144147
<div class="col-12 col-md-6 mt-3">
145-
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd. It was last built on 2025-06-03.</p>
148+
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd, Marcel Ramos Pérez, Martin Morgan. It was last built on 2025-06-06.</p>
146149
</div>
147150

148151
<div class="col-12 col-md-6 mt-3">

bioconductor-package-submissions.html

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@
99
<meta name="author" content="Daniela Cassol">
1010
<meta name="author" content="Johannes Rainer">
1111
<meta name="author" content="Lori Shepherd">
12-
<meta name="description" content="Introduction Types of Packages Package Naming Policy Author/Maintainer Expectations Submission Experiment data package Annotation package Workflow package Review Process Following Acceptance...">
12+
<meta name="author" content="Marcel Ramos Pérez">
13+
<meta name="author" content="Martin Morgan">
14+
<meta name="description" content="1.1 Introduction To submit a package to Bioconductor the package should: Address areas of high-throughput genomic analysis, e.g., sequencing, expression and other microarrays, flow cytometry, mass...">
1315
<meta name="generator" content="bookdown 0.43 with bs4_book()">
1416
<meta property="og:title" content="Chapter 1 Bioconductor Package Submissions | Bioconductor Packages: Development, Maintenance, and Peer Review">
1517
<meta property="og:type" content="book">
16-
<meta property="og:description" content="Introduction Types of Packages Package Naming Policy Author/Maintainer Expectations Submission Experiment data package Annotation package Workflow package Review Process Following Acceptance...">
18+
<meta property="og:description" content="1.1 Introduction To submit a package to Bioconductor the package should: Address areas of high-throughput genomic analysis, e.g., sequencing, expression and other microarrays, flow cytometry, mass...">
1719
<meta name="twitter:card" content="summary">
1820
<meta name="twitter:title" content="Chapter 1 Bioconductor Package Submissions | Bioconductor Packages: Development, Maintenance, and Peer Review">
19-
<meta name="twitter:description" content="Introduction Types of Packages Package Naming Policy Author/Maintainer Expectations Submission Experiment data package Annotation package Workflow package Review Process Following Acceptance...">
21+
<meta name="twitter:description" content="1.1 Introduction To submit a package to Bioconductor the package should: Address areas of high-throughput genomic analysis, e.g., sequencing, expression and other microarrays, flow cytometry, mass...">
2022
<!-- JS --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://kit.fontawesome.com/6ecbd6c532.js" crossorigin="anonymous"></script><script src="libs/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
2123
<link href="libs/bootstrap-4.6.0/bootstrap.min.css" rel="stylesheet">
2224
<script src="libs/bootstrap-4.6.0/bootstrap.bundle.min.js"></script><script src="libs/bs3compat-0.9.0/transition.js"></script><script src="libs/bs3compat-0.9.0/tabs.js"></script><script src="libs/bs3compat-0.9.0/bs3compat.js"></script><link href="libs/bs4_book-1.0.0/bs4_book.css" rel="stylesheet">
@@ -116,6 +118,7 @@ <h1>
116118
<li><a class="" href="cmavericks-best-practices.html"><span class="header-section-number">E</span> C++/Mavericks Best Practices</a></li>
117119
<li><a class="" href="man-links.html"><span class="header-section-number">F</span> Debug: Links in Rd files</a></li>
118120
<li><a class="" href="booknews.html"><span class="header-section-number">G</span> NEWS</a></li>
121+
<li><a class="" href="references-1.html"><span class="header-section-number">H</span> References</a></li>
119122
</ul>
120123

121124
<div class="book-extra">
@@ -127,19 +130,6 @@ <h1>
127130
<h1>
128131
<span class="header-section-number">1</span> Bioconductor Package Submissions<a class="anchor" aria-label="anchor" href="#bioconductor-package-submissions"><i class="fas fa-link"></i></a>
129132
</h1>
130-
<ul>
131-
<li><a href="bioconductor-package-submissions.html#subintro">Introduction</a></li>
132-
<li><a href="bioconductor-package-submissions.html#type">Types of Packages</a></li>
133-
<li><a href="bioconductor-package-submissions.html#naming">Package Naming Policy</a></li>
134-
<li><a href="bioconductor-package-submissions.html#author">Author/Maintainer Expectations</a></li>
135-
<li><a href="bioconductor-package-submissions.html#submission">Submission</a></li>
136-
<li><a href="bioconductor-package-submissions.html#experPackage">Experiment data package</a></li>
137-
<li><a href="bioconductor-package-submissions.html#annPackage">Annotation package</a></li>
138-
<li><a href="bioconductor-package-submissions.html#workPackage">Workflow package</a></li>
139-
<li><a href="bioconductor-package-submissions.html#whattoexpect">Review Process</a></li>
140-
<li><a href="bioconductor-package-submissions.html#afteraccept">Following Acceptance</a></li>
141-
<li><a href="bioconductor-package-submissions.html#support">Additional Support</a></li>
142-
</ul>
143133
<div id="subintro" class="section level2" number="1.1">
144134
<h2>
145135
<span class="header-section-number">1.1</span> Introduction<a class="anchor" aria-label="anchor" href="#subintro"><i class="fas fa-link"></i></a>
@@ -161,7 +151,7 @@ <h2>
161151
<li>Comply with <a href="develop-overview.html#develop-overview">Package Guidelines</a>.</li>
162152
<li>Your package cannot depend on any package (or version of a package)
163153
that is not (yet) available on CRAN or <em>Bioconductor</em>. The package should work
164-
with whatever current version of the package is publically available.</li>
154+
with whatever current version of the package is publicly available.</li>
165155
</ul>
166156
</div>
167157
<div id="type" class="section level2" number="1.2">
@@ -174,7 +164,7 @@ <h2>
174164
<ul>
175165
<li><p>Software Packages. Most packages contributed by users are software
176166
packages. Software packages provide implementation of algorithms
177-
(e.g. statistical analysis), access to resources (e.g. biomart, or NCBI) or
167+
(e.g. statistical analysis), access to resources (e.g. <code>biomaRt</code>, or NCBI) or
178168
visualizations (e.g. volcano plots, pathways plots). Instructions for creating
179169
Software packages can be found here: <a href="develop-overview.html#develop-overview">Package guidelines</a>.</p></li>
180170
<li><p><a href="bioconductor-package-submissions.html#annPackage">Annotation packages</a> are database-like packages that provide
@@ -217,7 +207,7 @@ <h2>
217207
package contributor discontinues package maintenance. See Bioconductor’s package
218208
<a href="package-end-of-life-policy.html#package-end-of-life-policy">end-of-life policy</a> for more details.</p></li>
219209
<li><p>Uniqueness of package name. Packages should be named in a way that does not
220-
conflict (irrespective of case) with any current or past BIOCONDUCTOR package,
210+
conflict (irrespective of case) with any current or past Bioconductor package,
221211
nor any current or past CRAN package.</p></li>
222212
</ol>
223213
<p>See <a href="package-name.html#package-name">Package naming guidelines</a> for more guidelines.</p>
@@ -231,11 +221,11 @@ <h2>
231221
<ul>
232222
<li>
233223
<p>Follow Bioconductor guidelines</p>
234-
<p>These include standard <a href="develop-overview.html#develop-overview">guidelines</a>, <a href="versionnum.html#versionnum">version numbering</a>,
235-
<a href="r-code.html#r-code">coding style</a>, <a href="general.html#correctness-space-and-time">code performance
236-
requirements</a>, <a href="general.html#memory">memory usage</a>, <a href="important-bioconductor-package-development-features.html#reusebioc">using
237-
existing data classes</a>, and the other requirements described
238-
below.</p>
224+
<p>These include standard <a href="develop-overview.html#develop-overview">guidelines</a>,
225+
<a href="versionnum.html#versionnum">version numbering</a>, <a href="r-code.html#r-code">coding style</a>,
226+
<a href="general.html#correctness-space-and-time">code performance requirements</a>,
227+
<a href="general.html#memory">memory usage</a>, <a href="important-bioconductor-package-development-features.html#reusebioc">using existing data classes</a>,
228+
and the other requirements described below.</p>
239229
</li>
240230
<li>
241231
<p>Follow the release cycle of Bioconductor</p>
@@ -287,11 +277,11 @@ <h2>
287277
It is important to promptly respond to bug reports and questions either on
288278
the <a href="https://support.bioconductor.org/"><em>Bioconductor</em> support site</a> post or directly to developers.
289279
Some maintainers prefer to indicate a <code>BugReports:</code> field in their package’s
290-
DESCRIPTION file. This field indicates a particular web page for submitting
280+
<code>DESCRIPTION</code> file. This field indicates a particular web page for submitting
291281
bug reports and questions.</p>
292282
</li>
293-
<li><p>Ensure the maintainer email in the DESCRIPTION stays accurate and
294-
reachable. The maintainer email in the DESCRIPTION is the definitive contact
283+
<li><p>Ensure the maintainer email in the <code>DESCRIPTION</code> stays accurate and
284+
reachable. The maintainer email in the <code>DESCRIPTION</code> is the definitive contact
295285
<em>Bioconductor</em> will use. It is important to keep this email up-to-date to
296286
ensure we can contact you if your package is failing or to notify you of any
297287
important upcoming impactful events. If the email is not reachable your
@@ -312,7 +302,7 @@ <h2>
312302
the issue you are opening. You cannot specify any alternative branches; the
313303
default branch is utilized. The default branch must contain only package
314304
code. Any files or directories for other applications (Github Actions,
315-
devtool, etc) should be in a different branch. If you are submitting two
305+
devtools, etc) should be in a different branch. If you are submitting two
316306
highly related packages or circular dependent packages please see
317307
<a href="https://github.com/Bioconductor/Contributions/blob/master/CONTRIBUTING.md#submitting-related-packages">here</a>. The lighter dependent or package that can be installed without
318308
a dependency should be submitted first; this is generally the associated data
@@ -484,7 +474,7 @@ <h2>
484474
<a href="versionnum.html#versionnum">Version numbering</a> guidelines. If developers don’t
485475
bump the version, the changes made to their package <em>do not propagate</em>
486476
to the <em>Bioconductor</em> web site and package repository.</li>
487-
<li>Devlopers should make sure the maintainer email in the DESCRIPTION stays
477+
<li>Developers should make sure the maintainer email in the <code>DESCRIPTION</code> stays
488478
accurate and reachable.</li>
489479
</ul>
490480
</div>
@@ -548,7 +538,7 @@ <h2>
548538
<footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
549539

550540
<div class="col-12 col-md-6 mt-3">
551-
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd. It was last built on 2025-06-03.</p>
541+
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd, Marcel Ramos Pérez, Martin Morgan. It was last built on 2025-06-06.</p>
552542
</div>
553543

554544
<div class="col-12 col-md-6 mt-3">

booknews.html

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<meta name="author" content="Daniela Cassol">
1010
<meta name="author" content="Johannes Rainer">
1111
<meta name="author" content="Lori Shepherd">
12+
<meta name="author" content="Marcel Ramos Pérez">
13+
<meta name="author" content="Martin Morgan">
1214
<meta name="description" content="G.1 Version 1.0.1 (2021-08-19) Add a dedicated section on the package name. G.2 Version 1.0.0 (2021-06-02) Initial definition of the package development guidelines based on Bioconductor package...">
1315
<meta name="generator" content="bookdown 0.43 with bs4_book()">
1416
<meta property="og:title" content="G NEWS | Bioconductor Packages: Development, Maintenance, and Peer Review">
@@ -116,6 +118,7 @@ <h1>
116118
<li><a class="" href="cmavericks-best-practices.html"><span class="header-section-number">E</span> C++/Mavericks Best Practices</a></li>
117119
<li><a class="" href="man-links.html"><span class="header-section-number">F</span> Debug: Links in Rd files</a></li>
118120
<li><a class="active" href="booknews.html"><span class="header-section-number">G</span> NEWS</a></li>
121+
<li><a class="" href="references-1.html"><span class="header-section-number">H</span> References</a></li>
119122
</ul>
120123

121124
<div class="book-extra">
@@ -143,23 +146,11 @@ <h2>
143146
<li>Initial definition of the package development guidelines based on
144147
Bioconductor package guidelines listed on main Bioconductor.org website.</li>
145148
</ul>
146-
<div id="refs" class="references csl-bib-body hanging-indent" entry-spacing="0">
147-
<div id="ref-Soneson2025-zr" class="csl-entry">
148-
Soneson, Charlotte, Lori Shepherd, Marcel Ramos, Kevin Rue-Albrecht, Johannes Rainer, Hervé Pagès, and Vincent J Carey. 2025. <span>“Eleven Quick Tips for Writing a Bioconductor Package.”</span> <em>PLoS Comput. Biol.</em> 21 (3): e1012856. <a href="https://doi.org/10.1371/journal.pcbi.1012856">https://doi.org/10.1371/journal.pcbi.1012856</a>.
149149
</div>
150150
</div>
151-
</div>
152-
</div>
153-
154-
155-
156-
157-
158-
159-
160151
<div class="chapter-nav">
161152
<div class="prev"><a href="man-links.html"><span class="header-section-number">F</span> Debug: Links in Rd files</a></div>
162-
<div class="empty"></div>
153+
<div class="next"><a href="references-1.html"><span class="header-section-number">H</span> References</a></div>
163154
</div></main><div class="col-md-3 col-lg-2 d-none d-md-block sidebar sidebar-chapter">
164155
<nav id="toc" data-toggle="toc" aria-label="On this page"><h2>On this page</h2>
165156
<ul class="nav navbar-nav">
@@ -183,7 +174,7 @@ <h2>
183174
<footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
184175

185176
<div class="col-12 col-md-6 mt-3">
186-
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd. It was last built on 2025-06-03.</p>
177+
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd, Marcel Ramos Pérez, Martin Morgan. It was last built on 2025-06-06.</p>
187178
</div>
188179

189180
<div class="col-12 col-md-6 mt-3">

branch-rename-faqs.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<meta name="author" content="Daniela Cassol">
1010
<meta name="author" content="Johannes Rainer">
1111
<meta name="author" content="Lori Shepherd">
12+
<meta name="author" content="Marcel Ramos Pérez">
13+
<meta name="author" content="Martin Morgan">
1214
<meta name="description" content="The Bioconductor project has chosen ‘devel’ to be the default branch for GitHub and git repositories. To prepare for this transition, we have compiled a list of Frequently Asked Questions (FAQs)...">
1315
<meta name="generator" content="bookdown 0.43 with bs4_book()">
1416
<meta property="og:title" content="Chapter 27 Branch Rename FAQs | Bioconductor Packages: Development, Maintenance, and Peer Review">
@@ -116,6 +118,7 @@ <h1>
116118
<li><a class="" href="cmavericks-best-practices.html"><span class="header-section-number">E</span> C++/Mavericks Best Practices</a></li>
117119
<li><a class="" href="man-links.html"><span class="header-section-number">F</span> Debug: Links in Rd files</a></li>
118120
<li><a class="" href="booknews.html"><span class="header-section-number">G</span> NEWS</a></li>
121+
<li><a class="" href="references-1.html"><span class="header-section-number">H</span> References</a></li>
119122
</ul>
120123

121124
<div class="book-extra">
@@ -372,7 +375,7 @@ <h2>
372375
<footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
373376

374377
<div class="col-12 col-md-6 mt-3">
375-
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd. It was last built on 2025-06-03.</p>
378+
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd, Marcel Ramos Pérez, Martin Morgan. It was last built on 2025-06-06.</p>
376379
</div>
377380

378381
<div class="col-12 col-md-6 mt-3">

c-fortran.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<meta name="author" content="Daniela Cassol">
1010
<meta name="author" content="Johannes Rainer">
1111
<meta name="author" content="Lori Shepherd">
12+
<meta name="author" content="Marcel Ramos Pérez">
13+
<meta name="author" content="Martin Morgan">
1214
<meta name="description" content="If the package contains C or Fortran code, it should adhere to the standards and methods described in the System and foreign language interfaces section of the Writing R Extensions manual. We...">
1315
<meta name="generator" content="bookdown 0.43 with bs4_book()">
1416
<meta property="og:title" content="D C and Fortran code | Bioconductor Packages: Development, Maintenance, and Peer Review">
@@ -116,6 +118,7 @@ <h1>
116118
<li><a class="" href="cmavericks-best-practices.html"><span class="header-section-number">E</span> C++/Mavericks Best Practices</a></li>
117119
<li><a class="" href="man-links.html"><span class="header-section-number">F</span> Debug: Links in Rd files</a></li>
118120
<li><a class="" href="booknews.html"><span class="header-section-number">G</span> NEWS</a></li>
121+
<li><a class="" href="references-1.html"><span class="header-section-number">H</span> References</a></li>
119122
</ul>
120123

121124
<div class="book-extra">
@@ -207,7 +210,7 @@ <h3>
207210
<footer class="bg-primary text-light mt-5"><div class="container"><div class="row">
208211

209212
<div class="col-12 col-md-6 mt-3">
210-
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd. It was last built on 2025-06-03.</p>
213+
<p>"<strong>Bioconductor Packages: Development, Maintenance, and Peer Review</strong>" was written by Kevin Rue-Albrecht, Daniela Cassol, Johannes Rainer, Lori Shepherd, Marcel Ramos Pérez, Martin Morgan. It was last built on 2025-06-06.</p>
211214
</div>
212215

213216
<div class="col-12 col-md-6 mt-3">

0 commit comments

Comments
 (0)