From 2d35964f566f2b0648b76fd23cc52c254fcc2867 Mon Sep 17 00:00:00 2001 From: nvelden Date: Mon, 24 May 2021 13:47:16 +0200 Subject: [PATCH] Spelling fixes --- R/NGLVieweR-shiny.R | 2 +- R/NGLVieweR.R | 6 +++--- R/api.R | 2 +- README.md | 2 +- man/NGLVieweR-shiny.Rd | 2 +- man/NGLVieweR.Rd | 6 +++--- man/updateVisibility.Rd | 2 +- vignettes/NGLVieweR.Rmd | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/R/NGLVieweR-shiny.R b/R/NGLVieweR-shiny.R index e758d07..6c206bd 100644 --- a/R/NGLVieweR-shiny.R +++ b/R/NGLVieweR-shiny.R @@ -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. diff --git a/R/NGLVieweR.R b/R/NGLVieweR.R index 554c051..1d0c7e8 100644 --- a/R/NGLVieweR.R +++ b/R/NGLVieweR.R @@ -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. @@ -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 #' diff --git a/R/api.R b/R/api.R index 8c20b29..ead2b5d 100644 --- a/R/api.R +++ b/R/api.R @@ -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. diff --git a/README.md b/README.md index c07a163..688cd8a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/man/NGLVieweR-shiny.Rd b/man/NGLVieweR-shiny.Rd index bb2f433..b57db62 100644 --- a/man/NGLVieweR-shiny.Rd +++ b/man/NGLVieweR-shiny.Rd @@ -20,7 +20,7 @@ NGLVieweR_proxy(id, session = shiny::getDefaultReactiveDomain()) \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a string and have \code{'px'} appended.} -\item{expr}{An expression that generates a NGLViewer.} +\item{expr}{An expression that generates a NGLVieweR.} \item{env}{The environment in which to evaluate \code{expr}.} diff --git a/man/NGLVieweR.Rd b/man/NGLVieweR.Rd index b987566..9165585 100644 --- a/man/NGLVieweR.Rd +++ b/man/NGLVieweR.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/NGLVieweR.R \name{NGLVieweR} \alias{NGLVieweR} -\title{Create a NGL viewer} +\title{Create a NGLVieweR} \usage{ NGLVieweR(data, format = NULL, width = NULL, height = NULL, elementId = NULL) } @@ -19,7 +19,7 @@ string and have \code{'px'} appended.} \item{elementId}{optional element Id} } \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{ @@ -155,7 +155,7 @@ shinyApp(ui, server) } \seealso{ \itemize{ -\item \code{\link[=NGLVieweR_proxy]{NGLVieweR_proxy()}} for handeling of API calls after rendering. +\item \code{\link[=NGLVieweR_proxy]{NGLVieweR_proxy()}} for handling of API calls after rendering. \item \code{\link[=NGLVieweR_example]{NGLVieweR_example()}} See example "API" and "basic". } } diff --git a/man/updateVisibility.Rd b/man/updateVisibility.Rd index 7dfe2c7..89aca1d 100644 --- a/man/updateVisibility.Rd +++ b/man/updateVisibility.Rd @@ -15,7 +15,7 @@ updateVisibility(NGLVieweR_proxy, name, value = FALSE) For a full description see "setVisibility" in the official \href{http://nglviewer.org/ngl/api/}{NGL.js} manual.} } \description{ -Hide or show an excisting NGLVieweR selection in Shinymode. +Hide or show an existing NGLVieweR selection in Shinymode. } \examples{ \dontrun{ diff --git a/vignettes/NGLVieweR.Rmd b/vignettes/NGLVieweR.Rmd index 0910665..6a2fe11 100644 --- a/vignettes/NGLVieweR.Rmd +++ b/vignettes/NGLVieweR.Rmd @@ -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)