diff --git a/DESCRIPTION b/DESCRIPTION index b2e6191..d84c724 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -6,8 +6,8 @@ Authors@R: c( person("Shantanu", "Singh", email = "shsingh@broadinstitute.org", role = c("aut", "cre", "cph")), person("Gregory", "Way", email = "gway@broadinstitute.org", role = c("aut")) ) -Description: Functions to calculate quality metrics for readouts from - high-throughput profiling experiments. +Description: Calculate quality metrics for readouts from high-throughput + profiling experiments. License: BSD_3_clause + file LICENSE Encoding: UTF-8 LazyData: true diff --git a/R/sim_read-write.R b/R/sim_read-write.R index e30e0f0..dbeb126 100644 --- a/R/sim_read-write.R +++ b/R/sim_read-write.R @@ -14,7 +14,7 @@ utils::globalVariables(c(".")) #' @param output character string specifying the output directory or filename. #' @param file_format character string specify file format. This must be one of \code{csv} or \code{parquet}(default). #' -#' @return NULL +#' @return No return value, called for side effects #' @export #' #' @importFrom magrittr %>% diff --git a/R/utils-tidy-eval.R b/R/utils-tidy-eval.R index 09c3698..238906f 100644 --- a/R/utils-tidy-eval.R +++ b/R/utils-tidy-eval.R @@ -104,4 +104,5 @@ #' @importFrom rlang enquo enquos .data := as_name as_label #' @aliases enquo enquos .data := as_name as_label #' @export enquo enquos .data := as_name as_label +#' @return No return value, called for side effects NULL diff --git a/README.Rmd b/README.Rmd index 91c13dc..b6d573a 100644 --- a/README.Rmd +++ b/README.Rmd @@ -21,9 +21,7 @@ knitr::opts_chunk$set( -Metrics for Similarity Matrices. - -`matric` contains functions to calculate quality metrics for readouts from high-throughput profiling experiments. +`matric` calculates quality metrics for readouts from high-throughput profiling experiments. ## Installation diff --git a/man/sim_write.Rd b/man/sim_write.Rd index 3527936..bde3586 100644 --- a/man/sim_write.Rd +++ b/man/sim_write.Rd @@ -13,6 +13,9 @@ sim_write(sim_df, output, file_format = "parquet") \item{file_format}{character string specify file format. This must be one of \code{csv} or \code{parquet}(default).} } +\value{ +No return value, called for side effects +} \description{ \code{sim_write} writes similarity matrix. } diff --git a/man/tidyeval.Rd b/man/tidyeval.Rd index f773abf..5abf2ec 100644 --- a/man/tidyeval.Rd +++ b/man/tidyeval.Rd @@ -9,6 +9,9 @@ \alias{as_name} \alias{as_label} \title{Tidy eval helpers} +\value{ +No return value, called for side effects +} \description{ This page lists the tidy eval tools reexported in this package from rlang. To learn about using tidy eval in scripts and packages at a