From c2a5f92d6f251a6daead22cf609df8748bffaba5 Mon Sep 17 00:00:00 2001 From: Tim Whiteaker Date: Thu, 26 Oct 2023 16:16:44 -0500 Subject: [PATCH] Fix some warnings --- DESCRIPTION | 2 +- R/insert_additional_metadata.R | 2 +- man/insert_additional_metadata.Rd | 2 +- man/order_cp_cols.Rd | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 4bd503e..9545f4d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,7 +5,7 @@ Version: 0.1.2 Authors@R: c( person("An T.", "Nguyen", email = "enthusiast@utexas.edu", role = c("aut", "cre")), person("Tim", "Whiteaker", email = "whiteaker@utexas.edu", role = "aut")) -Description: Utility functions for BLE LTER IM team +Description: This package contains utility functions for BLE LTER IM team. License: CC BY 4.0 Encoding: UTF-8 LazyData: true diff --git a/R/insert_additional_metadata.R b/R/insert_additional_metadata.R index 61dde3d..773930f 100644 --- a/R/insert_additional_metadata.R +++ b/R/insert_additional_metadata.R @@ -1,7 +1,7 @@ #' Insert additional metadata into an EML document #' @description Sometime, for various reasons, additional metadata just needs to be inserted into EML documents manually. This is for quickly doing that in R. The function adds a snippet of plain text EML after a specified line number in the EML file. A pattern can also be defined for grep-ing the line number to append to (e.g. additional metadata needs to be inserted after a specific line). The defaults reflect BLE's need to add a snippet to aid replication of metadata to the Arctic Data Center that for a certain reason cannot be added via our normal means (the EML R package). #' @param file (character) Path to EML file. Function will also write to this same file. -#' @param pattern (character) Grep pattern. \code{grep()} will be called on the contents of the file, and the first match will be used. Defaults to "<\dataset>". +#' @param pattern (character) Grep pattern. \code{grep()} will be called on the contents of the file, and the first match will be used. Defaults to "". #' @param addition (character) Plain text of EML snippet to insert. Defaults to an "additionalMetadata" node pertaining to replication I won't paste here. #' @param after (numeric) A line number to append after. Only comes into play if pattern is not found. No defaults. #' @return Nothing in the R environment, but a file with the snippet inserted where specified. File will remain the same diff --git a/man/insert_additional_metadata.Rd b/man/insert_additional_metadata.Rd index 0d4fcd1..a9be8ae 100644 --- a/man/insert_additional_metadata.Rd +++ b/man/insert_additional_metadata.Rd @@ -9,7 +9,7 @@ insert_additional_metadata(file, pattern = NULL, addition = NULL, after) \arguments{ \item{file}{(character) Path to EML file. Function will also write to this same file.} -\item{pattern}{(character) Grep pattern. \code{grep()} will be called on the contents of the file, and the first match will be used. Defaults to "<\dataset>".} +\item{pattern}{(character) Grep pattern. \code{grep()} will be called on the contents of the file, and the first match will be used. Defaults to "".} \item{addition}{(character) Plain text of EML snippet to insert. Defaults to an "additionalMetadata" node pertaining to replication I won't paste here.} diff --git a/man/order_cp_cols.Rd b/man/order_cp_cols.Rd index e986295..d2aa698 100644 --- a/man/order_cp_cols.Rd +++ b/man/order_cp_cols.Rd @@ -12,5 +12,5 @@ order_cp_cols(data, type) \item{type}{(character) Type of CP data. Choose from "water", "sediment", or "mooring". Use "sediment" for biota data as well.} } \description{ -Order Core Program data columns in this particular order: node, lagoon, station, season, date_time, water_column_position, (insert data columns), station_name, latitude, longitude, station_depth, habitat_type, station_sampling_priority. +Order Core Program data columns in this particular order: node, lagoon, station, season, date_time, water_column_position, (insert data columns), station_name, latitude, longitude, station_depth, habitat_type, station_sampling_priority. Note that station_depth is optional. }