diff --git a/DESCRIPTION b/DESCRIPTION index f5f7e55..1ed79e5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: logrx Title: A Logging Utility Focus on Clinical Trial Programming Workflows -Version: 0.1.0 +Version: 0.1.1 Authors@R: c( person(given = "Nathan", @@ -34,7 +34,7 @@ BugReports: https://github.com/atorus-research/logrx/issues Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.0 +RoxygenNote: 7.2.1 Imports: dplyr, magrittr, diff --git a/NEWS.md b/NEWS.md index 6039a1b..6b61791 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# logrx 0.1.1 + +Address CRAN comments about documentation. + # logrx 0.1.0 Beta release for logrx with introduction of numerous new features: diff --git a/R/interact.R b/R/interact.R index cea76bd..55c9c6c 100644 --- a/R/interact.R +++ b/R/interact.R @@ -44,10 +44,14 @@ get_log_element <- function(el_key){ } -#' Set the log name and path: -#' 1. As the name and path if specified -#' 2. As the file name and path if specified -#' 3. As logrx_log.log and . if none of the above are specified +#' Set the log name and path +#' +#' \enumerate{ +#' \item As the name and path if supplied +#' \item As the file name with .log extension and path if specified or +#' if they can be determined by the function +#' \item As logrx_log.log and . if none of the above are specified +#' } #' #' @param log_name The log name #' @param log_path The log path diff --git a/man/set_log_name_path.Rd b/man/set_log_name_path.Rd index 768a04b..4b67f8e 100644 --- a/man/set_log_name_path.Rd +++ b/man/set_log_name_path.Rd @@ -2,12 +2,7 @@ % Please edit documentation in R/interact.R \name{set_log_name_path} \alias{set_log_name_path} -\title{Set the log name and path: -\enumerate{ -\item As the name and path if specified -\item As the file name and path if specified -\item As logrx_log.log and . if none of the above are specified -}} +\title{Set the log name and path} \usage{ set_log_name_path(log_name = NA, log_path = NA) } @@ -20,10 +15,10 @@ set_log_name_path(log_name = NA, log_path = NA) Nothing } \description{ -Set the log name and path: \enumerate{ -\item As the name and path if specified -\item As the file name and path if specified +\item As the name and path if supplied +\item As the file name with .log extension and path if specified or +if they can be determined by the function \item As logrx_log.log and . if none of the above are specified } }