From 299bf733a75adb98b94dcd207f4029769c8558db Mon Sep 17 00:00:00 2001 From: nvelden Date: Mon, 24 May 2021 14:20:39 +0200 Subject: [PATCH] eradme update --- .Rbuildignore | 1 + CRAN-RELEASE | 2 ++ docs/articles/NGLVieweR.html | 30 +++++++++++++++--------------- vignettes/NGLVieweR.Rmd | 4 ++-- 4 files changed, 20 insertions(+), 17 deletions(-) create mode 100644 CRAN-RELEASE diff --git a/.Rbuildignore b/.Rbuildignore index 703fca6..058649d 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ ^LICENSE\.md ^\.github$ ^cran-comments\.md$ +^CRAN-RELEASE$ diff --git a/CRAN-RELEASE b/CRAN-RELEASE new file mode 100644 index 0000000..338ab53 --- /dev/null +++ b/CRAN-RELEASE @@ -0,0 +1,2 @@ +This package was submitted to CRAN on 2021-05-24. +Once it is accepted, delete this file and tag the release (commit 2d35964). diff --git a/docs/articles/NGLVieweR.html b/docs/articles/NGLVieweR.html index f2a3ece..42ea46d 100644 --- a/docs/articles/NGLVieweR.html +++ b/docs/articles/NGLVieweR.html @@ -111,8 +111,8 @@

NGLVieweR("7CID") %>% addRepresentation("cartoon")

Note: Use mouse for selection (left-click), rotate/move (left/right-click hold) and zooming (scroll wheel).

-
-

You can view a “basic” NGLVieweR Shiny application by running the below code. Use “API” for an example using API calls or any of the function names (e.g “addSelection”") for function specific examples.

+
+

You can view a “basic” NGLVieweR Shiny application by running the below code. Use “API” for an example using API calls or any of the function names (e.g “addSelection”") for function specific examples.

 library(NGLVieweR)
 library(shiny)
@@ -155,8 +155,8 @@ 

 "
 NGLVieweR(benz, format="sdf") %>%
   addRepresentation("ball+stick")
-
- +
+

@@ -185,8 +185,8 @@

opacity = 0.1 ) )

-
- +
+

@@ -211,8 +211,8 @@

param = list(name = "cartoon", colorScheme = "residueindex") ) %>% setSpin()

-
- +
+

@@ -245,8 +245,8 @@

# backgroundOpacity=0.5 ) )

-
- +
+

@@ -281,8 +281,8 @@

duration = 0, # animation time in ms z_offSet = -20 )

-
- +
+

@@ -352,8 +352,8 @@

# lineOfSightDistFactor= 1 ) )

-
- +
+

@@ -391,7 +391,7 @@

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.

 library(shiny)
 library(NGLVieweR)
diff --git a/vignettes/NGLVieweR.Rmd b/vignettes/NGLVieweR.Rmd
index 6a2fe11..bf9dcdf 100644
--- a/vignettes/NGLVieweR.Rmd
+++ b/vignettes/NGLVieweR.Rmd
@@ -314,7 +314,7 @@ shinyApp(ui, server)
 ```
 
 ```{r, echo=FALSE}
-knitr::include_graphics("../man/figures/basic_shiny.png")
+knitr::include_graphics("../man/figures/basic_shiny.PNG")
 ```
 
 ## API
@@ -370,7 +370,7 @@ shinyApp(ui, server)
 ```
 
 ```{r, echo=FALSE}
-knitr::include_graphics("../man/figures/API_Shiny.png")
+knitr::include_graphics("../man/figures/API_shiny.PNG")
 ```
 
 ### Possible API functions are: