CRAN checks

paulgovan · Sep 10, 2024 · 0f1d5d8 · 0f1d5d8
1 parent 25575c0
commit 0f1d5d8
Show file tree

Hide file tree

Showing 30 changed files with 599 additions and 251 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -6,23 +6,22 @@ Description: An interface to the 'AutoDesk' 'API' Platform including the Authent
     'API' for managing data across the platform's cloud services, Design Automation 'API'
     for performing automated tasks on design files in the cloud, Model
     Derivative 'API' for translating design files into different formats, sending
-    them to the viewer app, and extracting design data, and Viewer for rendering
-    2D and 3D models (see <https://developer.autodesk.com> for more information).
-Version: 0.1.4
-URL: https://github.com/paulgovan/autodeskr, http://paulgovan.github.io/AutoDeskR/, https://github.com/paulgovan/AutoDeskR
+    them to the viewer app, and extracting design data, and Viewer for rendering 
+    2D and 3D models.
+Version: 0.1.5
+URL: https://aps.autodesk.com, https://paulgovan.gitbook.io/autodeskr, http://paulgovan.github.io/AutoDeskR/, https://github.com/paulgovan/AutoDeskR
 BugReports: https://github.com/paulgovan/AutoDeskR/issues
 Authors@R: person("Paul", "Govan", email = "paul.govan2@gmail.com",
     role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0002-1821-8492"))
 Depends:
     R (>= 2.10.0)
 License: Apache License | file LICENSE
-LazyData: TRUE
 Imports:
     httr,
     jsonlite,
     shiny
 Encoding: UTF-8
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Suggests: knitr,
     rmarkdown
 VignetteBuilder: knitr
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,7 @@
+# AutoDeskR 0.1.5
+
+## Minor Improvements and Bug Fixes
+
 # AutoDeskR 0.1.3
 
 ## Major Changes

diff --git a/R/authentication.R b/R/authentication.R
@@ -14,7 +14,6 @@
 #'   combination of these.
 #' @return An object containing the \code{access_token}, \code{code_type}, and
 #'   \code{expires_in} milliseconds.
-#' @seealso \url{https://developer.autodesk.com/en/docs/oauth/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Get a 2-legged token with the "data:read" and "data:write" scopes

diff --git a/R/dataManagement.R b/R/dataManagement.R
@@ -9,7 +9,6 @@
 #'   \code{persistent}.
 #' @return An object containing the \code{bucketKey}, \code{bucketOwner}, and
 #'   \code{createdDate}.
-#' @seealso \url{https://developer.autodesk.com/en/docs/data/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Make a transient bucket with the name "mybucket"
@@ -57,7 +56,6 @@ makeBucket <- function(token = NULL, bucket = "mybucket", policy = "transient")
 #' @param bucket A string. Name of the bucket. Defaults to \code{mybucket}.
 #' @return An object containing the \code{bucketKey}, \code{bucketOwner}, and
 #'   \code{createdDate}.
-#' @seealso \url{https://developer.autodesk.com/en/docs/data/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Check the status of a bucket with the name "mybucket"
@@ -106,7 +104,6 @@ checkBucket <- function(token = NULL, bucket = "mybucket") {
 #'   urn), \code{objectKey} (i.e. file name), \code{size}, \code{contentType}
 #'   (i.e. "application/octet-stream"), \code{location}. and other content
 #'   information.
-#' @seealso \url{https://developer.autodesk.com/en/docs/data/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Upload the "aerial.dwg" file to "mybucket"

diff --git a/R/designAutomation.R b/R/designAutomation.R
@@ -7,8 +7,6 @@
 #'   pdf file.
 #' @param token A string. Token generated with \code{\link{getToken}} function
 #'   with \code{code:all} scope.
-#' @seealso
-#'   \url{https://developer.autodesk.com/en/docs/design-automation/v2/overview/}
 #' @examples
 #' \dontrun{
 #' mySource <- "http://download.autodesk.com/us/samplefiles/acad/visualization_-_aerial.dwg"
@@ -82,8 +80,6 @@ makePdf <- function(source = NULL, destination = NULL, token = NULL) {
 #'   pdf file.
 #' @param token A string. Token generated with \code{\link{getToken}} function
 #'   with \code{code:all} scope.
-#' @seealso
-#'   \url{https://developer.autodesk.com/en/docs/design-automation/v2/overview/}
 #' @examples
 #' \dontrun{
 #' mySource <- "http://download.autodesk.com/us/samplefiles/acad/visualization_-_aerial.dwg"

diff --git a/R/modelDerivative.R b/R/modelDerivative.R
@@ -8,8 +8,6 @@
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the \code{result}, \code{urn}, and additional
 #'   activity information.
-#' @seealso
-#'   \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Translate the "aerial.dwg" file into a svf file
@@ -72,8 +70,6 @@ translateSvf <- function(urn = NULL, token = NULL) {
 #'   \code{jsonlite::base64_enc} function.
 #' @param token A string. Token generated with \code{\link{getToken}} function
 #'   with \code{data:read} and \code{data:write} scopes.
-#' @seealso
-#'   \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Check the status of the translated "aerial.dwg" svf file
@@ -120,8 +116,6 @@ checkFile <- function(urn = NULL, token = NULL) {
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the \code{type}, \code{name}, and \code{guid} of
 #'   the file.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Get the metadata for the "aerial.dwg" svf file
@@ -168,8 +162,6 @@ getMetadata <- function(urn = NULL, token = NULL) {
 #' @param token A string. Token generated with \code{\link{getToken}} function
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the geometry data for the selected file.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Get the geometry data for the "aerial.dwg" svf file
@@ -217,8 +209,6 @@ getData <- function(guid = NULL, urn = NULL, token = NULL) {
 #' @param token A string. Token generated with \code{\link{getToken}} function
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the object tree for the selected file. the file.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Get the object tree for the "aerial.dwg" svf file
@@ -265,8 +255,6 @@ getObjectTree <- function(guid = NULL, urn = NULL, token = NULL){
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the \code{result}, \code{urn}, and additional
 #'   activity information.
-#' @seealso
-#'   \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Translate the "aerial.dwg" file into a obj file
@@ -326,8 +314,6 @@ translateObj <- function(urn = NULL, token = NULL) {
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the \code{result}, \code{urn}, and additional
 #'   activity information.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Get the output urn for the "aerial.dwg" obj file
@@ -376,8 +362,6 @@ getOutputUrn <- function(urn, token) {
 #'   with \code{data:read} and \code{data:write} scopes.
 #' @return An object containing the \code{result}, \code{urn}, and additional
 #'   activity information.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/model-derivative/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # Download the "aerial.dwg" png file

diff --git a/R/viewer.R b/R/viewer.R
@@ -8,8 +8,6 @@
 #' @param viewerType A string. The type of viewer to instantiate. Either
 #'   "header" for the default viewer, "headless" for a viewer without toolbar
 #'   or panels, or "vr" to enter WebVR mode on a mobile device.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/viewer/v2/overview/}
 #' @examples
 #' \dontrun{
 #' # View the "aerial.dwg" file in the AutoDesk viewer
@@ -59,8 +57,6 @@ viewer3D <- function(urn = NULL, token = NULL, viewerType = "header") {
 #' @param viewerType A string. The type of viewer to instantiate. Either
 #'   "header" for the default viewer or "headless" for a viewer without toolbar
 #'   or panels.
-#' @seealso
-#' \url{https://developer.autodesk.com/en/docs/viewer/v2/overview/}
 #' @examples
 #' \dontrun{
 #' ui <- function(request) {

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 ![](https://github.com/paulgovan/AutoDeskR/blob/master/inst/images/basicSample.png?raw=true)
 
-# Introduction
+## Introduction
 AutoDeskR is an R package that provides an interface to the:
 
 * Authentication API for obtaining authentication to the AutoDesk Forge Platfrom.
@@ -17,7 +17,7 @@ AutoDeskR is an R package that provides an interface to the:
 * Model Derivative API for translating design files into different formats, sending them to the viewer app, and extracting model data.
 * Viewer for rendering 2D and 3D models.
 
-# Quick Start
+## Quick Start
 To install AutoDeskR in [R](https://www.r-project.org):
 
 ```
@@ -31,8 +31,7 @@ devtools::install_github('paulgovan/autodeskr')
 ```
 
 ## Code of Conduct
-
 Please note that the AutoDeskR project is released with a [Contributor Code of Conduct](http://paulgovan.github.io/AutoDeskR/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
 
-# Acknowledgements
-Many thanks to the developers at [AutoDesk](https://github.com/Developer-Autodesk) for providing this great set of tools and for the support needed to learn and implement these APIs.
+## Acknowledgements
+Many thanks to the developers at [https://aps.autodesk.com](https://aps.autodesk.com) for providing this great set of tools and for the support needed to learn and implement these APIs.
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,9 +1,25 @@
-## Test environments
-* local OS X install, R 3.2.2
-* win-builder (devel and release)
-
 ## R CMD check results
-There were no ERRORs, WARNINGs or NOTES.
+
+0 errors | 0 warnings | 1 note
+
+* New maintainer:
+    Paul Govan <paul.govan2@gmail.com>
+  Old maintainer(s):
+    Paul Govan <pgovan1@aggienetwork.com>
 
-## Downstream dependencies
-There are currently no downstream dependencies for this package.
+  Found the following (possibly) invalid URLs:
+    URL: https://aps.autodesk.com
+      From: DESCRIPTION
+            README.md
+      Status: 406
+      Message: Not Acceptable
+    URL: https://aps.autodesk.com/en/docs/oauth/v2/tutorials/create-app/
+      From: inst/doc/Authentication.html
+      Status: 406
+      Message: Not Acceptable
+
+The old maintainer email address was deactivated, and these URLs are correct. 
+
+## Reverse Dependencies
+
+There are currently no reverse dependencies. 
diff --git a/inst/CITATION b/inst/CITATION
@@ -1,25 +1,22 @@
 citHeader("To cite AutoDeskR in publications use:")
 
-citEntry(
-  entry    = "Book",
-  title    = "AutoDeskR: An R Interface to the AutoDesk API Platform",
+bibentry(
+  bibtype  = "Book",
+  title    = "AutoDeskR: An Interface to the AutoDesk API Platform",
   author   = "Paul Govan",
   year     = "2018",
   publisher = "GitBook",
   edition  = "1",
   url      = "https://paulgovan.gitbook.io/autodeskr",
-  doi      = "10.5281/zenodo.1137877",
-  textVersion = paste(
-
-  )
+  doi      = "10.5281/zenodo.1137877"
 )
 
-citEntry(
-  entry    = "Manual",
-  title    = "AutoDeskR: An R Interface to the AutoDesk API Platform",
+bibentry(
+  bibtype   = "Manual",
+  title    = "AutoDeskR: An Interface to the AutoDesk API Platform",
   author   = "Paul Govan",
-  year     = "2017",
-  note     = "R package version 0.1.3,
-  url      = "https://CRAN.R-project.org/package=AutoDeskR",
-  doi      = "10.32614/CRAN.package.AutoDeskR"
+  year     = "2024",
+  note     = "R package version 0.1.5",
+  url = "https://cran.r-project.org/package=AutoDeskR",
+  doi = "10.32614/CRAN.package.AutoDeskR"
 )
diff --git a/man/checkBucket.Rd b/man/checkBucket.Rd
diff --git a/man/checkFile.Rd b/man/checkFile.Rd
diff --git a/man/checkPdf.Rd b/man/checkPdf.Rd
diff --git a/man/downloadFile.Rd b/man/downloadFile.Rd
diff --git a/man/getData.Rd b/man/getData.Rd
diff --git a/man/getMetadata.Rd b/man/getMetadata.Rd
diff --git a/man/getObjectTree.Rd b/man/getObjectTree.Rd
diff --git a/man/getOutputUrn.Rd b/man/getOutputUrn.Rd
diff --git a/man/getToken.Rd b/man/getToken.Rd
diff --git a/man/makeBucket.Rd b/man/makeBucket.Rd
diff --git a/man/makePdf.Rd b/man/makePdf.Rd
diff --git a/man/translateObj.Rd b/man/translateObj.Rd
diff --git a/man/translateSvf.Rd b/man/translateSvf.Rd
diff --git a/man/uploadFile.Rd b/man/uploadFile.Rd
diff --git a/man/viewer3D.Rd b/man/viewer3D.Rd
diff --git a/man/viewerUI.Rd b/man/viewerUI.Rd
diff --git a/vignettes/Authentication.Rmd b/vignettes/Authentication.Rmd
@@ -8,7 +8,7 @@ vignette: >
 ---
 
 # Authentication
-AutoDesk uses OAuth-based authentication for access to their services. To get started with this package, first visit the [Create an App](https://developer.autodesk.com/en/docs/oauth/v2/tutorials/create-app/) tutorial for instructions on creating an app and getting a Client ID and Secret. 
+AutoDesk uses OAuth-based authentication for access to their services. To get started with this package, first visit the **Create an App** tutorial at [https://aps.autodesk.com/en/docs/oauth/v2/tutorials/create-app/](https://aps.autodesk.com/en/docs/oauth/v2/tutorials/create-app/) for instructions on creating an app and getting a Client ID and Secret. 
 
 We highly recommend that the Client ID, Secret, and access tokens be stored in a file called `.Renviron` and accessing these keys with the `Sys.getenv()` function. This step is a possible solution for preventing authentication information from being in a publicly accessible location (e.g. GitHub repo). For more information on storing keys in the `.Renviron` file and accessing them with `Sys.getenv()`, see the appendix in this [API Best Practices](https://CRAN.R-project.org/package=httr/vignettes/api-packages.html) vignette.