[rkward] scripts: updated roxyPackage script for 'rkward' R package

m.eik michalke null at kde.org
Tue May 22 16:56:45 UTC 2018


Git commit d04fb373d1af3461fc8f5b1045ec73828b57192b by m.eik michalke.
Committed on 22/05/2018 at 16:51.
Pushed by meikm into branch 'master'.

updated roxyPackage script for 'rkward' R package

M  +86   -65   scripts/rkward_roxyPackage.R

https://commits.kde.org/rkward/d04fb373d1af3461fc8f5b1045ec73828b57192b

diff --git a/scripts/rkward_roxyPackage.R b/scripts/rkward_roxyPackage.R
old mode 100644
new mode 100755
index 528ea02d..66278930
--- a/scripts/rkward_roxyPackage.R
+++ b/scripts/rkward_roxyPackage.R
@@ -3,80 +3,101 @@
 # to use it
 #  1. install the package "roxyPackage"
 #  2. make a local copy of this file
-#  3. checkout the lates rkward package sources via svn
+#  3. checkout the lates rkward package sources via git
 #  4. cusomize the first part of the script (see below, you MUST set these paths correctly!)
 #  5. run the script
 
 ## setup environment
-# .libPaths("~/R")
 require(roxyPackage)
 
 local({
-	#######################
-	## these are the values you probably need to update
-	#######################
-	package.version <- "0.6.3"
+  #######################
+  ## these are the values you probably need to update
+  #######################
+  package.version <- "0.7.1"
 
-	# this should point to the "rkward" root directory of the R package
-	package.sources <- file.path("/PathTo","trunk","rkward","rkward","rbackend","rpackages","rkward")
-	# path to R libs -- where should the package be installed to?
-	install.path <- file.path("~", "R")
-	# packages are copied to a "local repository", that is simply a folder
-	# to create some files and directories. it can actually be used as a
-	# R repository
-	local.repository <- file.path("/PathTo", "repo_rkward")
+  # this should point to the "rkward" root directory of the R package
+  package.sources <- file.path("/PathTo","git","rkward","rkward","rbackend","rpackages","rkward")
+  # packages are copied to a "local repository", that is simply a folder
+  # to create some files and directories. it can actually be used as a
+  # R repository
+  local.repository <- tempdir() # file.path("/PathTo", "repo_rkward")
+  # path to R libs -- where should the package be installed to?
+  install.path <- .libPaths()[1]
+  # use sandbox mode -- see ?sandbox
+  sandbox(TRUE)
 
-	# what should be done? (un)comment actions as needed
-	roxyPackage.actions <- c(
-	## documentation:
-		# "roxy" is needed also to update NAMESPACE; but beware that
-		# it will overwrite the docs, so be careful with svn commits
-		# until the docs are fully tagged!
-				"roxy",			# roxygenize the docs
-				"cite",			# update CITATION file
-	# 			"doc",			# update pdf documentation
-	# 			"cl2news",		# convert ChangeLog into NEWS.Rd
-	## local repository:
-	# 			"news2rss",		# convert NEWS.Rd into RSS feed
-	# 			"html",			# update index.html
-	# 			"win",			# update the windows binary package
-	# 			"macosx",		# update the mac OS X binary package
-	## build:
-				"package" 		# build & install the package
-	# 			"check"			# check package
-	)
+  # what should be done? (un)comment actions as needed
+  roxyPackage.actions <- c(
+  ## documentation:
+    # "roxy" is needed also to update NAMESPACE; but beware that
+    # it will overwrite the docs, so be careful with svn commits
+    # until the docs are fully tagged!
+        "roxy",           # roxygenize the docs
+        "cite",           # update CITATION file
+  #       "doc",            # update pdf documentation
+  #       "cl2news",        # convert ChangeLog into NEWS.Rd
+  #       "cleanRd",        # linebreaks for >90 chars in *.Rd
+  #       "log",            # update ChangeLog
+  #       "buildVignettes", # re-build vignettes with index
+  ## local repository:
+  #       "news2rss",       # convert NEWS.Rd into RSS feed
+  #       "html",           # update index.html
+  #       "win",            # update the windows binary package
+  #       "macosx",         # update the mac OS X binary package
+  ## build:
+        "package"         # build & install the package
+  #     "buildVignettes", "package", "check" # check package
+  ## initialize files
+  #        "readme"         # add initial README.md file
+  #        "license"        # update LICENSE file
+  #        "vignette"       # add Rmd vignette stub
+  )
 
-	#######################
-	## from here on all should be left untouched
-	#######################
-	# package description
-	package.description <-data.frame(
-		Package="rkward",
-		Type="Package",
-		Title="Provides functions related to the RKWard GUI",
-		Author="Thomas Friedrichsmeier <thomas.friedrichsmeier at ruhr-uni-bochum.de> and the RKWard Team <rkward-devel at lists.sourceforge.net>",
-		AuthorsR="c(person(given=\"Thomas\", family=\"Friedrichsmeier\", email=\"thomas.friedrichsmeier at ruhr-uni-bochum.de\",
-				role=c(\"aut\")),
-			person(given=\"RKWard-devel\", family=\"mailing list\", email=\"rkward-devel at lists.sourceforge.net\",
-				role=c(\"cre\",\"ctb\")))",
-		Maintainer="RKWard-devel mailing list <rkward-devel at lists.sourceforge.net>",
-		## TODO: check dependencies
-		Depends="R (>= 2.9.0),methods",
-		Description="This package contains functions which are useful in combination with the RKWard GUI. Many of these
-			functions only needed for the internal communication between RKWard and R, but some are also useful in user scripts.",
-		License="GPL (>= 2)",
-		Encoding="UTF-8",
-		LazyLoad="yes",
-		URL="http://rkward.kde.org",
-		stringsAsFactors=FALSE)
+  #######################
+  ## from here on all should be left untouched
+  #######################
+  # package description
+  package.description <- package_description(
+    Package="rkward",
+    Type="Package",
+    Title="Provides functions related to the RKWard GUI",
+    Author="Thomas Friedrichsmeier <thomas.friedrichsmeier at ruhr-uni-bochum.de> and the RKWard Team <rkward-devel at kde.org>",
+    AuthorsR="c(person(given=\"Thomas\", family=\"Friedrichsmeier\", email=\"thomas.friedrichsmeier at ruhr-uni-bochum.de\",
+        role=c(\"aut\")),
+      person(given=\"the RKWard\", family=\"team\", email=\"rkward-devel at kde.org\",
+        role=c(\"cre\",\"ctb\")))",
+    Maintainer="RKWard-devel mailing list <rkward-devel at kde.org>",
+    ## TODO: check dependencies
+    Depends="R (>= 2.9.0),methods",
+    #Suggests="testthat,knitr,rmarkdown",
+    #VignetteBuilder="knitr",
+    Description="This package contains functions which are useful in combination with the RKWard GUI. Many of these
+      functions only needed for the internal communication between RKWard and R, but some are also useful in user scripts.",
+    License="GPL (>= 2)",
+    Encoding="UTF-8",
+    LazyLoad="yes",
+    URL="https://rkward.kde.org",
+    BugReports="https://rkward.kde.org/Bugs"
+  )
 
-	## here we go
-	roxy.package(actions=roxyPackage.actions,
-		pck.source.dir=package.sources,
-		pck.version=package.version,
-		pck.description=package.description,
-		R.libs=install.path,
-		repo.root=local.repository,
-		cleanup=TRUE,
-		URL="http://rkward.kde.org")
+  ## here we go
+  roxy.package(actions=roxyPackage.actions,
+    pck.source.dir=package.sources,
+    pck.version=package.version,
+    pck.description=package.description,
+    R.libs=install.path,
+    repo.root=local.repository,
+    cleanup=TRUE,
+    URL="http://rkward.kde.org",
+    #readme.options=list(
+    #  githubUser=""
+    #),
+    html.options=list(
+      flattr.id="myxw65",
+      repo.flattr.id="myxw65"#,
+      #imprint="https://rkward.kde.org/...",
+      #privacy.policy="https://rkward.kde.org/..."
+    )
+  )
 })



More information about the rkward-tracker mailing list