Skip to content

Commit 8f2487d

Browse files
committed
Deploying to gh-pages from @ 6f510ab 🚀
1 parent e614873 commit 8f2487d

File tree

4 files changed

+29
-13
lines changed

4 files changed

+29
-13
lines changed

description.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,8 @@ <h2>
265265
be included to document the process. If a user facing <a href="readme.html#readme"><code>README</code></a> is included it
266266
is also recommended to document the process there; do not try to install a
267267
dependency for a user anywhere in the package (i.e. readme, r code, man pages,
268-
vignette). You may show instructions only in unevaluated sections.</p>
268+
vignette). You may show instructions only in unevaluated sections. See also
269+
<a href="r-code.html#rcode-sysdep">Additional files and dependencies</a></p>
269270
</div>
270271
<div id="description-biocviews" class="section level2" number="6.10">
271272
<h2>

r-code.html

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -329,16 +329,28 @@ <h4>
329329
<h4>
330330
<span class="header-section-number">15.2.6.5</span> Additional files and dependencies<a class="anchor" aria-label="anchor" href="#rcode-sysdep"><i class="fas fa-link"></i></a>
331331
</h4>
332-
<p>Do NOT install anything on a users system.</p>
333-
<p>System dependencies, applications, and additionally needed packages should be
334-
assumed already present on the user’s system.</p>
335-
<p>If necessary, package maintainers should provide instructions for download and
336-
setup, but should not execute those instructions on behalf of a
337-
user. Complicated or additional system dependency instructions could be part of
338-
the <a href="readme.html#readme">README file</a> and/or <a href="sysdep.html#sysdep">INSTALL file</a>. All package
339-
dependencies must actively be on CRAN or <a href="https://bioconductor.org"><em>Bioconductor</em></a>.</p>
332+
<p>Do NOT install anything on a users system! System dependencies, applications,
333+
and additionally needed packages should be assumed already present on the user’s
334+
system.</p>
335+
<p>Direct calls to external commands via
336+
system() or system2() are not ideal so should only be used when there is no
337+
other alternative. For example, if a CRAN or Bioconductor package already
338+
provides the functionality that you are after, you should use that instead.</p>
339+
<p>Now if your package <strong>absolutely</strong> must rely on external software then you
340+
need to make sure that those requirements are listed in
341+
the SystemRequirements field of the DESCRIPTION file of the package. These
342+
requirements should be “reasonable” requirements, that is, trusted software
343+
only, open source, and relatively easy to install.</p>
344+
<p>Additionally we ask that the package contains an <a href="sysdep.html#sysdep">INSTALL file</a> (in the
345+
top-level folder) that provides instructions for installing the external
346+
software on the 3 major OS that we support: Linux, Windows, and Mac. This
347+
will not only help your users get the external software on their machines,
348+
but it will also help us install it on the build machines if it’s not
349+
already there.</p>
340350
<p>All system and package dependencies should be the latest publically available
341-
version.</p>
351+
version. All package dependencies must actively be on CRAN or
352+
Bioconductor. Bioconductor will not recognize Remotes in Description and will
353+
not install a lower version of a package or dependency.</p>
342354
</div>
343355
<div id="rcode-namespaces" class="section level4" number="15.2.6.6">
344356
<h4>

search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sysdep.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,11 @@ <h1>
106106
<p>An INSTALL file does not have to be included with the package. An INSTALL file
107107
is utilized for specifying external system requirements needed. It should be
108108
used in combination with the <code>SystemRequirements</code> field of the <a href="description.html#description-sysdep">Description
109-
file</a>. This file should contain installation instructions
110-
for the required system dependency.</p>
109+
file</a>. This file should provide instructions for installing
110+
the external software on the 3 major OS that we support: Linux, Windows, and
111+
Mac. This will not only help your users get the external software on their
112+
machines, but it will also help us install it on the build machines if it’s not
113+
already there.</p>
111114
<p>Specifying this requirement does not guarantee that <em>Bioconductor</em> will agree to
112115
install the external system requirement. It is encouraged to discuss any
113116
additional system requirements on the <a href="mailto:[email protected]" class="email">[email protected]</a> before

0 commit comments

Comments
 (0)