Skip to content

Commit

Permalink
Spelling fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nvelden committed May 24, 2021
1 parent d673e24 commit 2d35964
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion R/NGLVieweR-shiny.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
#' \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
#' string and have \code{'px'} appended.
#' @param expr An expression that generates a NGLViewer.
#' @param expr An expression that generates a NGLVieweR.
#' @param env The environment in which to evaluate \code{expr}.
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
#' is useful if you want to save an expression in a variable.
Expand Down
6 changes: 3 additions & 3 deletions R/NGLVieweR.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
#' @export
tools::file_ext

#' Create a NGL viewer
#' Create a NGLVieweR
#'@description
#' NGLvieweR can be used to visualize and interact with Protein Data Bank (PDB) and structural files in R and Shiny applications.
#' NGLVieweR can be used to visualize and interact with Protein Data Bank (PDB) and structural files in R and Shiny applications.
#' It includes a set of API functions to manipulate the viewer after creation in Shiny.
#'@details
#'The package is based on the \href{http://nglviewer.org/ngl/api/}{NGL.js} Javascript library.
Expand All @@ -18,7 +18,7 @@ tools::file_ext
#' string and have \code{'px'} appended.
#'@param elementId optional element Id
#'@seealso
#'* [NGLVieweR_proxy()] for handeling of API calls after rendering.
#'* [NGLVieweR_proxy()] for handling of API calls after rendering.
#'* [NGLVieweR_example()] See example "API" and "basic".
#'@examples
#'
Expand Down
2 changes: 1 addition & 1 deletion R/api.R
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ snapShot <- function(NGLVieweR_proxy, fileName = "Snapshot", param = list()) {
#'Update visibility
#'
#'@description
#'Hide or show an excisting NGLVieweR selection in Shinymode.
#'Hide or show an existing NGLVieweR selection in Shinymode.
#'@param NGLVieweR_proxy A NGLVieweR object.
#'@param name Name of selection to alter the color.
#'@param value Hide \code{FALSE} or show \code{TRUE} selection.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ addRepresentation("cartoon")
There are functions provided to:

- Overlay different representation styles
- Alter the stage parameters (eg. background, zoom- and rotation speed)
- Alter the stage parameters (e.g. background, zoom- and rotation speed)
- Zoom to specific selections
- Add labels
- Add contacts between residues
Expand Down
2 changes: 1 addition & 1 deletion man/NGLVieweR-shiny.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/NGLVieweR.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/updateVisibility.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/NGLVieweR.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ knitr::include_graphics("../man/figures/basic_shiny.png")

## API

In Shiny apps, you can manipulate the **NGLVieweR** widget after creation using specific "API" calls. You can for instance add or remove representations by refering to their name using the `addSelection()` or `removeSelection()` functions.
In Shiny apps, you can manipulate the **NGLVieweR** widget after creation using specific "API" calls. You can for instance add or remove representations by referring to their name using the `addSelection()` or `removeSelection()` functions.

```{r eval=FALSE}
library(shiny)
Expand Down

0 comments on commit 2d35964

Please sign in to comment.