Merge pull request #24 from RobLBaker/main

Version 0.0.1
nationalparkservice · Sep 12, 2023 · 4f111bf · 4f111bf
2 parents 3fcda6b + e804a0f
commit 4f111bf
Show file tree

Hide file tree

Showing 19 changed files with 104 additions and 28 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: NPSdataverse
 Title: Tools and Packages for Data and Metadata Manipulation
-Version: 0.0.0.9
+Version: 0.0.1
 Authors@R: c(
     person(given="Robert", family="Baker", email="[email protected]",
            role = c("aut", "cre"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,11 @@
+# NPSdatavers 0.0.1
+
+2023-09-12
+
+* updated version to be in line with forthcoming versioning guidance
+* updated documentation to assist in install/updating 
+* updated updateR.R to tell the user not only when data packages are out of date but also when they are all up to date upon loading NPSdataverse.
+
 # NPSdataverse 0.0.0.9000
 
 * Added a `NEWS.md` file to track changes to the package.
diff --git a/R/updateR.R b/R/updateR.R
@@ -6,7 +6,12 @@
 #' @keywords internal
 #'
 .update_git_repos<-function(){
-  git_pkgs = c("NPSdataverse", "QCkit", "EMLeditor", "DPchecker", "NPSutils", "EMLassemblyline")
+  git_pkgs = c("NPSdataverse",
+               "QCkit",
+               "EMLeditor",
+               "DPchecker",
+               "NPSutils",
+               "EMLassemblyline")
   pkg_update <- remotes::package_deps(git_pkgs, dependencies = c("Imports",
                                                                  "Remotes",
                                                                  "Suggests"))
@@ -30,6 +35,14 @@
     cli::cat_line("\nClose R and Rstudio. Open a new R session and reload the NPSdataverse.")
     cli::cat_line()
   }
+  else{
+    load_header <- cli::rule(
+      left = cli::pluralize(
+       "All NPSdataverse packages are up to date."))
+    msg(load_header)
+    cli::cat_line()
+  }
+
 }
 
 #' Custom print function for github repos to update

diff --git a/README.Rmd b/README.Rmd
@@ -42,9 +42,33 @@ NPSdataverse will install the following R packages:
 ***
 (R packages in **bold** are developed by NPS)
 
-## Updating R packages
+## Trouble shooting installation
 
-Many of the NPSdataverse packages are in a phase of rapid development. NPSdataverse will check for new versions of the packages stored on gitub (all the packages except r/EML) each time you load NPSdataverse. If any of your packages are out of date, please follow the instructions to update them.  
+Each package within the NPSdataverse has a number of dependencies, most of which
+are hosted on CRAN. During the initial install of NPSdataverse, you may be
+prompted to install or update these dependencies. The initial installation can
+take some time and require multiple iterative package updates/installs. 
+Depending on how they were initially installed, some dependent packages may fail
+update or to install. In this case you can try running 
+
+``` r
+.libPaths()
+```
+to find where your packages are located on your local machine. Navigate to that
+location and delete the offending package. Then try to re-install.
+
+
+## Updating NPSdataverse packages
+
+Many of the NPSdataverse packages are in a phase of rapid development. When you
+load the NPSdataverse (using `library(NPSdataverse)`), NPSdataverse will check
+for new versions of the packages stored on GitHub (all the packages except
+r/EML). NPSdataverse will tell you if all your packages are up to date. 
+Conversely if any of the NPSdataverse packages need to be updated, NPSdataverse
+will indicate which packages need updating and how to perform the updates. If 
+you do not get any notices about whether your packages are up to date or not, 
+then the NPSdataverse package itself needs to be updated. See Installation for 
+instructions on how to update the NPSdataverse package.
 
 ## Creating data packages
 

diff --git a/README.md b/README.md
@@ -35,13 +35,36 @@ NPSdataverse will install the following R packages:
 
 (R packages in **bold** are developed by NPS)
 
-## Updating R packages
+## Trouble shooting installation
+
+Each package within the NPSdataverse has a number of dependencies, most
+of which are hosted on CRAN. During the initial install of NPSdataverse,
+you may be prompted to install or update these dependencies. The initial
+installation can take some time and require multiple iterative package
+updates/installs. Depending on how they were initially installed, some
+dependent packages may fail update or to install. In this case you can
+try running
+
+``` r
+.libPaths()
+```
+
+to find where your packages are located on your local machine. Navigate
+to that location and delete the offending package. Then try to
+re-install.
+
+## Updating NPSdataverse packages
 
 Many of the NPSdataverse packages are in a phase of rapid development.
-NPSdataverse will check for new versions of the packages stored on gitub
-(all the packages except r/EML) each time you load NPSdataverse. If any
-of your packages are out of date, please follow the instructions to
-update them.
+When you load the NPSdataverse (using `library(NPSdataverse)`),
+NPSdataverse will check for new versions of the packages stored on
+GitHub (all the packages except r/EML). NPSdataverse will tell you if
+all your packages are up to date. Conversely if any of the NPSdataverse
+packages need to be updated, NPSdataverse will indicate which packages
+need updating and how to perform the updates. If you do not get any
+notices about whether your packages are up to date or not, then the
+NPSdataverse package itself needs to be updated. See Installation for
+instructions on how to update the NPSdataverse package.
 
 ## Creating data packages
 

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/NPSdataverse.html b/docs/articles/NPSdataverse.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -1,7 +1,7 @@
-pandoc: 2.19.2
+pandoc: 3.1.1
 pkgdown: 2.0.6.9000
 pkgdown_sha: 5bb671b1a8bac8e926479868681936f7c9ee41b3
 articles:
   NPSdataverse: NPSdataverse.html
-last_built: 2023-05-02T17:51Z
+last_built: 2023-09-12T22:27Z
 
diff --git a/docs/reference/NPSdataverse_packages.html b/docs/reference/NPSdataverse_packages.html
diff --git a/docs/reference/detach_NPSdataverse.html b/docs/reference/detach_NPSdataverse.html
diff --git a/docs/reference/dot-print_cust_package_deps.html b/docs/reference/dot-print_cust_package_deps.html
diff --git a/docs/reference/dot-update_git_repos.html b/docs/reference/dot-update_git_repos.html
diff --git a/docs/reference/index.html b/docs/reference/index.html