Skip to content
Snippets Groups Projects
Commit 96d2f0ec authored by Hervé Pagès's avatar Hervé Pagès
Browse files

Clean up use of biocLite & add BiocManager to Suggests field

parent bab7e299
No related branches found
No related tags found
No related merge requests found
Package: splatter
Type: Package
Title: Simple Simulation of Single-cell RNA Sequencing Data
Version: 1.5.4
Version: 1.5.5
Date: 2018-08-20
Author: Luke Zappia
Authors@R:
......@@ -60,7 +60,8 @@ Suggests:
phenopath,
BASiCS,
zinbwave,
SparseDC
SparseDC,
BiocManager
biocViews: SingleCell, RNASeq, Transcriptomics, GeneExpression, Sequencing,
Software
URL: https://github.com/Oshlack/splatter
......
......@@ -26,8 +26,7 @@ simulations and real datasets.
Splatter is available from [Bioconductor][bioc] for R >=3.4.
If you have this installed Splatter can be installed from Bioconductor using
`biocLite`:
It can be installed from Bioconductor with:
```{r}
if (!requireNamespace("BiocManager", quietly=TRUE))
......
......@@ -97,11 +97,17 @@
<h1 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h1>
<p>Splatter can be installed from Bioconductor:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb1-1" data-line-number="1"><span class="kw">source</span>(<span class="st">"https://bioconductor.org/biocLite.R"</span>)</a>
<a class="sourceLine" id="cb1-2" data-line-number="2"><span class="kw">biocLite</span>(<span class="st">"splatter"</span>)</a></code></pre></div>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r">
if (!requireNamespace("BiocManager", quietly=TRUE))
install.packages("BiocManager")
BiocManager::install("splatter")
</code></pre></div>
<p>To install the most recent development version from Github use:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" data-line-number="1"><span class="kw">biocLite</span>(<span class="st">"Oshlack/splatter"</span>, <span class="dt">dependencies =</span> <span class="ot">TRUE</span>,</a>
<a class="sourceLine" id="cb2-2" data-line-number="2"> <span class="dt">build_vignettes =</span> <span class="ot">TRUE</span>)</a></code></pre></div>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r">
if (!requireNamespace("BiocManager", quietly=TRUE))
install.packages("BiocManager")
BiocManager::install("Oshlack/splatter", build_vignettes=TRUE)
</code></pre></div>
</div>
<div id="quickstart" class="section level1">
<h1 class="hasAnchor">
......
......@@ -99,22 +99,24 @@
<h3 class="hasAnchor">
<a href="#release-version" class="anchor"></a>Release version</h3>
<p>Splatter has been accepted into the latest version of <a href="https://bioconductor.org/packages/splatter">Bioconductor</a> and hence requires the latest version of R (&gt;=3.4).</p>
<p>If you have these installed Splatter can be installed from Bioconductor using <code>biocLite</code>:</p>
<pre class="{r}"><code>source("https://bioconductor.org/biocLite.R")
biocLite("splatter")</code></pre>
<p>If you have these installed Splatter can be installed from Bioconductor with:</p>
<pre class="{r}"><code>
if (!requireNamespace("BiocManager", quietly=TRUE))
install.packages("BiocManager")
BiocManager::install("splatter")
</code></pre>
<p>If you wish to build a local version of the vignette use:</p>
<pre class="{r}"><code><a href="http://www.rdocumentation.org/packages/BiocInstaller/topics/biocLite">biocLite("splatter", build_vignettes=TRUE)</a></code></pre>
<pre class="{r}"><code>
if (!requireNamespace("BiocManager", quietly=TRUE))
install.packages("BiocManager")
BiocManager::install("splatter", build_vignettes=TRUE, dependencies=TRUE)
</code></pre>
<p>This will also build the vignette and install all suggested dependencies (which aren’t required for core functionality). Building the vignette may sometimes fail when run from the command line, if this happens try running the install command in RStudio.</p>
</div>
<div id="development-version" class="section level3">
<h3 class="hasAnchor">
<a href="#development-version" class="anchor"></a>Development version</h3>
<p>If you want to try the <a href="https://bioconductor.org/packages/devel/bioc/html/splatter.html">development version</a> this can also be installed from Bioconductor:</p>
<pre class="{r}"><code>library(BiocInstaller)
useDevel()
biocValid() # checks for out of date packages
biocLite() # (optional) updates out of date packages
biocLite("splatter")</code></pre>
<p>To try the development version, follow the instructions provided on the <a href="https://bioconductor.org/packages/devel/bioc/html/splatter.html">landing page of the development version</a>.</p>
<p>Depending on the current release cycle you may also need to install the development version of R. See <a href="https://www.bioconductor.org/developers/how-to/useDevel/">here</a> for more details.</p>
<p>Alternatively the development version can be installed directly from <a href="https://github.com/Oshlack/splatter">Github</a>:</p>
<pre class="{r}"><code><a href="http://www.rdocumentation.org/packages/devtools/topics/install">devtools::install("Oshlack/splatter")</a></code></pre>
......
......@@ -30,8 +30,7 @@ https://bioconductor.org/packages/splatter.
Splatter has been accepted into the latest version of [Bioconductor][bioc]
and hence requires the latest version of R (>=3.4).
If you have these installed Splatter can be installed from Bioconductor using
`biocLite`:
It can be installed from Bioconductor with:
```{r}
if (!requireNamespace("BiocManager", quietly=TRUE))
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment