Merge pull request #11 from KWB-R/dev

mrustl · web-flow · commit 23cc496ad48e · 2020-01-10T13:55:51.000+01:00
Prepare release 0.1.0
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -7,9 +7,9 @@
 ^\.RData$
 ^\.Rproj\.user$
 ^\.here$
-^.travis\.yml$
+^\.travis\.yml$
 ^.gitlab-ci\.yml$
 ^appveyor\.yml$
-^index\.Rmd$
+^index\.md$
 ^README\.md$
 ^R/\.setup\.R
diff --git a/.travis.yml b/.travis.yml
@@ -1,3 +1,11 @@
+##############################################################################
+### Autogenerated with R package kwb.pkgbuild v0.1.1
+### (installed from 'Github (kwb-r/kwb.pkgbuild@0ac3694)' source code on 2019-09-06)
+### by calling the function kwb.pkgbuild::use_travis()
+### (file created at: 2019-09-09 10:34:55)
+##############################################################################
+
+
 language: r
 sudo: required
 cache: packages
@@ -16,4 +24,8 @@ matrix:
       provider: script
       script: Rscript -e 'pkgdown::deploy_site_github(verbose = TRUE)'
       skip_cleanup: 'true'
+      on:
+        branch: 
+        - master
+        - dev
   - r: oldrel
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: kwb.endnote
 Title: Helper Functions for Analysing KWB Endnote Library
     (Exported as .xml)
-Version: 0.0.0.9000
+Version: 0.1.0
 Authors@R: 
     c(person(given = "Michael",
              family = "Rustler",
@@ -25,7 +25,7 @@ Imports:
     forcats,
     fs,
     ggplot2,
-    kwb.fakin,
+    kwb.file,
     kwb.read,
     kwb.utils,
     magrittr,
@@ -41,7 +41,7 @@ Suggests:
     knitr,
     rmarkdown
 Remotes:
-    github::kwb-r/kwb.fakin,
+    github::kwb-r/kwb.file,
     github::kwb-r/kwb.read,
     github::kwb-r/kwb.utils
 Encoding: UTF-8
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2019 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
+Copyright (c) 2019 - 2020 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2019 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
+Copyright (c) 2019 - 2020 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/NAMESPACE b/NAMESPACE
@@ -58,7 +58,7 @@ importFrom(dplyr,select_if)
 importFrom(dplyr,starts_with)
 importFrom(forcats,fct_reorder)
 importFrom(fs,file_info)
-importFrom(kwb.fakin,toSubdirMatrix)
+importFrom(kwb.file,to_subdir_matrix)
 importFrom(kwb.read,read_xml_as_path_value)
 importFrom(kwb.utils,catAndRun)
 importFrom(kwb.utils,catIf)
diff --git a/R/.setup.R b/R/.setup.R
@@ -21,7 +21,7 @@ kwb.pkgbuild::add_gitlabci_to_ghpages("kwb.endnote", dest_dir = tempdir())
 
 usethis::use_vignette("analyse-endnote")
 
-pkg_dependencies <- c('dplyr', 'kwb.fakin', 'kwb.read', 'stringr')
+pkg_dependencies <- c('dplyr', 'kwb.file', 'kwb.read', 'stringr')
 
 sapply(pkg_dependencies, usethis::use_package)
 desc::desc_normalize()
diff --git a/R/check_for_differences.R b/R/check_for_differences.R
@@ -17,8 +17,8 @@
 #' ### Check differences between two different versions of "KWB_documents.xml"
 #' ############################################################################
 #'
-#' old_xml <- extdata_file("2019-01-07_KWB_documents.xml")
-#' new_xml <- extdata_file("2019-01-14_KWB_documents.xml")
+#' old_xml <- extdata_file("2019-01-14_KWB_documents.xml")
+#' new_xml <- extdata_file("2019-07-09_KWB_documents.xml")
 #' old_list <- kwb.endnote::create_endnote_list(old_xml)
 #' new_list <- kwb.endnote::create_endnote_list(new_xml)
 #' old_df <- kwb.endnote::create_references_df(old_list)
diff --git a/R/create_df_from_endnote_xml.R b/R/create_df_from_endnote_xml.R
@@ -6,7 +6,7 @@
 #'   from get_reference_type_names()
 #' @export
 #' @importFrom kwb.read read_xml_as_path_value
-#' @importFrom kwb.fakin toSubdirMatrix
+#' @importFrom kwb.file to_subdir_matrix
 #' @importFrom stringr str_remove_all
 #' @importFrom dplyr left_join
 #' @importFrom fs file_info
@@ -21,7 +21,7 @@ create_df_from_endnote_xml <- function(endnote_xml = default_xml()) {
     stringr::str_remove_all(pattern = "^/xml/records/record")
 
   references_df <- kwb.utils::asNoFactorDataFrame(cbind(
-    kwb.fakin::toSubdirMatrix(xml_paths),
+    kwb.file::to_subdir_matrix(xml_paths),
     references[, -1]
   ))
 
diff --git a/R/helper.R b/R/helper.R
@@ -20,7 +20,7 @@ colname_i <- function(name, i) {
 #' @export
 #'
 default_xml <- function() {
-  extdata_file("2019-01-07_KWB_documents.xml")
+  extdata_file("2019-07-09_KWB_documents.xml")
 }
 
 # first_of_element -------------------------------------------------------------
diff --git a/index.md b/index.md
@@ -9,7 +9,7 @@ Helper Functions For Analysing KWB Endnote Library
 
 ## Installation
 
-```{r echo = TRUE, eval = FALSE}
+```r
 #install.packages("remotes", repos = "https://cloud.r-project.org")
 remotes::install_github("KWB-R/kwb.endnote")
 ```
diff --git a/inst/extdata/2019-01-07_KWB_documents.xml b/inst/extdata/2019-01-07_KWB_documents.xml
diff --git a/inst/extdata/2019-07-09_KWB_documents.xml b/inst/extdata/2019-07-09_KWB_documents.xml
diff --git a/man/check_for_differences.Rd b/man/check_for_differences.Rd
diff --git a/vignettes/analyse-endnote.Rmd b/vignettes/analyse-endnote.Rmd
@@ -211,8 +211,9 @@ In total `r percent_pubs_with_project_meta` percent (i.e.
 contain meta-information on the project. However, the spelling of project names
 does not follow a controlled vocabulary yet as can be seen in the table above. 
 
-Thus it is recommended to establish a controlled vocabulary for [project acroyms](https://kwb-r.github.io/fakin.doc/best-practices.html#acronyms) 
-according to the best-practices defined in the FAKIN project (see [here](https://kwb-r.github.io/fakin.doc/best-practices.html#acronyms))
+Thus it is recommended to establish a controlled vocabulary for [project identifiers](https://kwb-r.github.io/fakin.doc/qms.html#project-identifier) 
+according to the best-practices defined in the FAKIN project (see 
+[here](https://kwb-r.github.io/fakin.doc/best-practices.html#acronyms)).
 
 ## By Author
 
diff --git a/vignettes/workflow.Rmd b/vignettes/workflow.Rmd
@@ -23,10 +23,12 @@ knitr::opts_chunk$set(
 library(kwb.endnote)
 
 ## Path to ENDNOTE XML 
-endnote_xml <- kwb.endnote::default_xml()
+endnote_xml <-  kwb.endnote::default_xml()
 endnote_list <- kwb.endnote::create_endnote_list(endnote_xml)
 ```
 
+The imported Endnote XML library is: `r basename(endnote_xml)`
+
 ## Check Import 
 
 ### Use Case 1: Unclean/Clean Versions
@@ -53,8 +55,8 @@ diffs_df %>%
 
 ```{r echo=TRUE}
 
-en_old_xml <- kwb.endnote::extdata_file("2019-01-07_KWB_documents.xml")
-en_new_xml <- kwb.endnote::extdata_file("2019-01-14_KWB_documents.xml")
+en_old_xml <- kwb.endnote::extdata_file("2019-01-14_KWB_documents.xml")
+en_new_xml <- kwb.endnote::extdata_file("2019-07-09_KWB_documents.xml")
 
 en_old_list <- kwb.endnote::create_endnote_list(en_old_xml)
 en_new_list <- kwb.endnote::create_endnote_list(en_new_xml)

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ colname_i <- function(name, i) {`
`20`	`20`	`#' @export`
`21`	`21`	`#'`
`22`	`22`	`default_xml <- function() {`
`23`		`- extdata_file("2019-01-07_KWB_documents.xml")`
	`23`	`+ extdata_file("2019-07-09_KWB_documents.xml")`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`# first_of_element -------------------------------------------------------------`