updating doc and site

NCEAS · Aug 27, 2018 · 4de5836 · 4de5836
1 parent fababde
commit 4de5836
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 52 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -3,9 +3,7 @@
 export(check_version)
 export(download_d1_data)
 export(download_d1_data_pkg)
-export(get_pkg_pids)
 export(read_d1_files)
-export(tabularize_eml)
 import(dataone)
 import(dplyr)
 import(eml2)

diff --git a/R/download_d1_data_pkg.R b/R/download_d1_data_pkg.R
@@ -1,7 +1,7 @@
 
-#' Download all the datasets from a data package
+#' Downloads all the datasets of a data package from DataONE
 #'
-#' @param meta_obj (character) A DOI for a DataONE package to download.
+#' @param meta_obj (character) A DOI for a DataONE package to download
 #' @param path (character) Path to a directory to download data to
 #'
 #' @import purrr

diff --git a/R/get_pkg_pids.R b/R/get_pkg_pids.R
@@ -7,8 +7,6 @@
 #' @importFrom dataone query CNode
 #' @importFrom purrr %||%
 #'
-#' @export
-#'
 #' @examples
 #' \dontrun{
 #' #get all pids in the data package

diff --git a/R/read_d1_files.R b/R/read_d1_files.R
@@ -1,4 +1,4 @@
-#' Read data along with metadata based on dowload_d1_data file structure
+#' Read data along with metadata into your R environment based on dowload_d1_data file structure
 #'
 #' @param folder_path (character) Path to a directory where data and metadata are located
 #' @param fnc (character) Function to be used to read the data (default is readr::read_csv)

diff --git a/R/tabularize_eml.R b/R/tabularize_eml.R
@@ -6,8 +6,6 @@
 #' @param full (logical) Returns the most commonly used metadata fields by default. 
 #' If \code{full = TRUE} is specified, the full set of metadata fields are returned.
 #'
-#' @export
-#'
 #' @importFrom tibble enframe
 #'
 #' @examples

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -0,0 +1,7 @@
+reference:
+  - title: metajam functions
+    contents:
+    - '`download_d1_data`'
+    - '`download_d1_data_pkg`'
+    - '`read_d1_files`'
+    - '`check_version`'
diff --git a/docs/articles/batch-processing.html b/docs/articles/batch-processing.html
diff --git a/docs/articles/downloading-entire-packages.html b/docs/articles/downloading-entire-packages.html
diff --git a/docs/articles/single-dataset.html b/docs/articles/single-dataset.html
diff --git a/docs/reference/download_d1_data_pkg.html b/docs/reference/download_d1_data_pkg.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/read_d1_files.html b/docs/reference/read_d1_files.html
diff --git a/man/download_d1_data_pkg.Rd b/man/download_d1_data_pkg.Rd
diff --git a/man/read_d1_files.Rd b/man/read_d1_files.Rd