Skip to content

Commit 8a0a4e3

Browse files
authored
Fix typos (#142)
* Fix typos * Rewrap paragraph to fix r rendering * Remove extra i
1 parent 081158d commit 8a0a4e3

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

description-file.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ guidelines:
142142
field of `GenomicAlignments`.
143143
It is unusual for more than three packages to be listed as `Depends:`.
144144
- `Suggests:` is for packages used in vignettes, examples, and in conditional
145-
code.Commonly, annotation and experiment packages (e.g., `TxDb*`) used in
145+
code. Commonly, annotation and experiment packages (e.g., `TxDb*`) used in
146146
vignette and example code are included in this field thus avoiding a costly
147147
download. In the case where an external one-off function is required for
148148
package code, the package availability and usage can be done via:
@@ -194,7 +194,7 @@ package type (i.e., `Software`, `AnnotationData`, `ExperimentData`, or
194194
The field name "biocViews" is case-sensitive and must begin with a lower-case
195195
'b'. Please use a single line with biocViews seperated by commas
196196

197-
(i.e,`biocViews: GeneTarget, SingleCell`).
197+
(i.e,`biocViews: GeneTarget, SingleCell`).
198198

199199
## `BugReports` {#description-bugreport}
200200

documentation.Rmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ it is always possible to extend existing classes.
2626
A vignette demonstrates how to accomplish non-trivial tasks embodying the core
2727
functionality of your package. There are two common types of vignettes.
2828

29-
* (Recommended) An *R markdown* vignette is similar to a *Sweave* vignette, but uses
30-
[markdown](http://daringfireball.net/projects/markdown/) instead of $\LaTeX$
31-
for structuring text sections and resulting in HTML output. The `r
32-
BiocStyle::CRANpkg("knitr")` package can process most *Sweave* and all *R
29+
* (Recommended) An *R markdown* vignette is similar to a *Sweave* vignette, but
30+
uses [markdown](http://daringfireball.net/projects/markdown/) instead of
31+
$\LaTeX$ for structuring text sections and resulting in HTML output. The
32+
`r BiocStyle::CRANpkg("knitr")` package can process most *Sweave* and all *R
3333
markdown* vignettes, producing pleasing output. Refer to [Writing package
34-
vignettes][CRAN vigs] for technical details. See the `r
35-
BiocStyle::Biocpkg("BiocStyle")` package for a convenient way to use common
34+
vignettes][CRAN vigs] for technical details. See the
35+
`r BiocStyle::Biocpkg("BiocStyle")` package for a convenient way to use common
3636
macros and a standard _Bioconductor_ style vignette.
3737

3838
* A *Sweave* vignette is an `.Rnw` file that contains $\LaTeX$ and chunks of <i
@@ -103,7 +103,7 @@ Add an "Installation" section that show to users how to download and load the
103103
package from Bioconductor.
104104

105105
These instructions and any installations instructions should be in an
106-
`eval=FALSE` code chunk. No where in the code (<i class="fab fa-r-project"></i>
106+
`eval=FALSE` code chunk. Nowhere in the code (<i class="fab fa-r-project"></i>
107107
code, man pages, vignettes, Rmd files) should someone try to install or download
108108
system dependencies, applications, packages, etc. Developers can provide
109109
instructions to follow in unevaluated code chunks, and should assume all

non-software-packages.Rmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ expected the majority of vignette code chunks are evaluated.
5858
* Write a package with the same name as the workflow. The workflow vignette
5959
written in Markdown, using the [rmarkdown][] package should be included in the
6060
vignette directory. You may include more than one vignette but please use
61-
useful identifying names.
61+
useful identifying names.
6262

6363
* The package does not need man/ or R/ directories nor a data/ directory as
6464
ideally workflows make use of existing data in a Bioconductor repository or on
@@ -72,7 +72,7 @@ expected the majority of vignette code chunks are evaluated.
7272

7373
* Submit the package to the [GitHub submission tracker][tracker] for a formal
7474
review. Please also indicate in the tracker issue that this package is a
75-
workflow.
75+
workflow.
7676

7777
* Workflows are git version controlled. Once the package is accepted it will be
7878
added to our git repository at [email protected] and instructions will
@@ -91,13 +91,13 @@ expected the majority of vignette code chunks are evaluated.
9191
BiocStyle::html_document
9292
```
9393

94-
* The following should also be include
94+
* The following should also be included
9595

9696
- author affiliations
9797
- a date representing when the workflow vignette has been modified
9898

9999
* The first section should have some versioning information. The R version,
100-
Bioconductor version, and package version should be visible.
100+
Bioconductor version, and package version should be visible.
101101
The following is an example of how this could be achieved:
102102

103103
<pre>
@@ -123,14 +123,14 @@ The following is taken as an example header from the variants workflow package:
123123
<code>
124124
&ndash; &ndash; &ndash;
125125
title&#58; Annotating Genomic Variants
126-
author&#58;
126+
author&#58;
127127
&ndash;name&#58; Valerie Obenchain
128128
affiliation&#58; Fred Hutchinson Cancer Research Center, 1100 Fairview Ave. N., P.O. Box 19024, Seattle, WA, USA 98109&ndash;1024
129129
date&#58; 11 April 2018
130130
vignette&#58; &#62;
131131
&#37;&#92;VignetteIndexEntry&#123;Annotating Genomic Variants&#125;
132132
&#37;&#92;VignetteEngine&#123;knitr&#58;&#58;rmarkdown&#125;
133-
output&#58;
133+
output&#58;
134134
BiocStyle&#58;&#58;html&#95;document
135135
&ndash; &ndash; &ndash;
136136

package-submission.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ package maintenance responsibilities. Package authors are expected to:
168168
DESCRIPTION file. This field indicates a particular web page for submitting
169169
bug reports and questions.
170170

171-
* Ensure the maintainer email in the DESCRIPTIONS stays accurate and
171+
* Ensure the maintainer email in the DESCRIPTION stays accurate and
172172
reachable. The maintainer email in the DESCRIPTION is the definitive contact
173173
_Bioconductor_ will use. It is important to keep this email up-to-date to
174174
ensure we can contact you if your package is failing or to notify you of any
@@ -257,7 +257,7 @@ use of existing data in a Bioconductor package. See development section on
257257
* The moderator will add your package as a repository to the
258258
git.bioconductor.org git server, copy the SSH keys from your github
259259
account to the [BiocCredentials application][] application and the issue labelled
260-
`pre-review`.
260+
`pre-review`.
261261

262262
ALL CHANGES TO YOUR PACKAGE must be pushed to the
263263
git.bioconductor.org repository created in this step. See the [New package

r-code.Rmd

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# R code {#r-code}
22

33
Everyone has their own coding style and formats. There are however some best
4-
practice guidelines that [_Bioconductor_ reviewers][reviewer-list] will look for.
4+
practice guidelines that [_Bioconductor_ reviewers][reviewer-list] will look for.
55

66
<i class="fab fa-r-project"></i> can be a robust, fast and efficient programming
77
language but often some coding practices result in less than ideal use of
@@ -31,7 +31,7 @@ Make use of appropriate existing packages (e.g.,
3131
`r BiocStyle::Biocpkg("GenomicRanges")`) and classes (e.g.,
3232
`r BiocStyle::Biocpkg("SummarizedExperiment")`,
3333
`r BiocStyle::Biocpkg("Biobase")`::AnnotatedDataFrame,
34-
`r BiocStyle::Biocpkg("GenomicRanges")`:;GRanges,
34+
`r BiocStyle::Biocpkg("GenomicRanges")`::GRanges,
3535
`r BiocStyle::Biocpkg("Biostrings")`::DNAStringSet) to avoid duplication of functionality
3636
available in other [_Bioconductor_][] packages. See
3737
also [Common Bioconductor Methods and Classes][bioc-common].
@@ -75,7 +75,7 @@ we recommend to use standard file format classes inheriting from
7575
### Naming of packages, functions, and classes {#naming-functions}
7676

7777
See section on [package naming](#package-name). The concepts there should also
78-
apply to function names, class names, etc.
78+
apply to function names, class names, etc.
7979

8080
Avoid names that:
8181

@@ -111,7 +111,7 @@ separate packages.
111111

112112
Remember to **re-use** [common _Bioconductor_ methods and classes][bioc-common]
113113
before implementing new representations. This encourages
114-
interoperability and simplifies your own package development.
114+
interoperability and simplifies your own package development.
115115

116116
#### Class Names {#class-names}
117117

@@ -123,7 +123,7 @@ _Bioconductor_ prefers the use of S4 classes over S3 class. Please use the S4
123123
representation for designing new classes. Again, we can not emphasize enough to
124124
reuse existing class structure if at all possible. If an existing class
125125
structure is not sufficient, it is also encouraged to look at extending or
126-
containing an [existing _Bioconductor_ class](#commonclass).
126+
containing an [existing _Bioconductor_ class](#commonclass).
127127

128128
If your data requires a new representation or function, carefully
129129
design an S4 class or generic so that other package developers with
@@ -168,7 +168,7 @@ installation.
168168

169169

170170
### Function development {#function-development}
171-
171+
172172
#### Functions Names {#rcode-function-names}
173173

174174
Function names should follow the following conventions:
@@ -195,7 +195,7 @@ helper functions.
195195
* Nesting functions should be avoiding. It unnecessarily increases the main
196196
function length and makes the main function harder to read. Helper functions
197197
and internal functions should avoid being nested and include at the end of the
198-
file or as a seperate file (e.g. internal.R, helpers.R, utils.R)
198+
file or as a seperate file (e.g. internal.R, helpers.R, utils.R)
199199

200200
#### Function arguments {#function-arguments}
201201

@@ -233,8 +233,8 @@ already there.
233233

234234
All system and package dependencies should be the latest publically available
235235
version. All package dependencies must actively be on CRAN or
236-
Bioconductor. Bioconductor will not recognize Remotes in Description and will
237-
not install a lower version of a package or dependency.
236+
Bioconductor. Bioconductor will not recognize Remotes in DESCRIPTION and will
237+
not install a lower version of a package or dependency.
238238

239239
#### Namespaces {#rcode-namespaces}
240240

@@ -387,7 +387,7 @@ from a variable.
387387
* `warning()` communicates unusual situations handled by your code.
388388
* `stop()` indicates an error condition.
389389
* `cat()` or `print()` are used only when displaying an object to the user in a `show` method.
390-
390+
391391
#### Graphic Device
392392

393393
Use `dev.new()` to start a graphics drive if necessary. Avoid using `x11()`
@@ -433,7 +433,7 @@ coding practices can be very unfortunate. Here are some suggestions.
433433
### Reuse Existing Functionality and Classes
434434

435435
Emphasized again for good measure! Reuse existing import/export methods,
436-
functionality, and classes whenever possible.
436+
functionality, and classes whenever possible.
437437

438438
### Vectorize
439439

0 commit comments

Comments
 (0)