From ba569540991e2ada986230f8481e5dcea4a88a44 Mon Sep 17 00:00:00 2001 From: Zachary Foster Date: Mon, 22 May 2017 20:31:35 -0700 Subject: [PATCH] spelling corrections --- man/class_from_class.Rd | 4 ++-- man/contaminants.Rd | 2 +- man/diverging_palette.Rd | 2 +- man/extract_taxonomy.Rd | 2 +- man/get_numerics.Rd | 2 +- man/heat_tree.Rd | 14 +++++++------- man/label_bounds.Rd | 2 +- man/layout_functions.Rd | 2 +- man/metacoder.Rd | 4 ++-- man/molten_dist.Rd | 4 ++-- man/parse_hmp_qiime.Rd | 2 +- man/parse_taxonomy_table.Rd | 2 +- man/primersearch.Rd | 2 +- man/qualitative_palette.Rd | 2 +- man/quantative_palette.Rd | 2 +- man/rdp_ex_data.Rd | 2 +- man/remove_redundant_names.Rd | 2 +- man/rescale.Rd | 2 +- man/sample_frac_obs.Rd | 2 +- man/sample_frac_taxa.Rd | 2 +- man/subtaxa.Rd | 2 +- man/validate_regex_key_pair.Rd | 2 +- 22 files changed, 31 insertions(+), 31 deletions(-) diff --git a/man/class_from_class.Rd b/man/class_from_class.Rd index 9caf82e..25bd463 100644 --- a/man/class_from_class.Rd +++ b/man/class_from_class.Rd @@ -17,7 +17,7 @@ The length of \code{class_key} must be equal to the number of capturing groups s Any names added to the terms will be used as column names in the output. At least \code{"taxon_id"} or \code{"name"} must be specified. Only \code{"taxon_info"} can be used multiple times. -Each term must be one of those decribed below: +Each term must be one of those described below: \describe{ \item{\code{taxon_id}}{A unique numeric id for a taxon for a particular \code{database} (e.g. ncbi accession number). Requires an internet connection.} @@ -36,7 +36,7 @@ The character(s) used to separate individual taxa within a classification.} \item{class_rev}{(\code{logical} of length 1) Used with the \code{class} term in the \code{key} argument. -If \code{TRUE}, the order of taxon data in a classfication is reversed to be specific to broad.} +If \code{TRUE}, the order of taxon data in a classification is reversed to be specific to broad.} \item{database}{(\code{character} of length 1) The name of the database that patterns given in \code{parser} will apply to. Valid databases include "ncbi", "itis", "eol", "col", "tropicos", diff --git a/man/contaminants.Rd b/man/contaminants.Rd index 4c195c5..8b1dcc0 100644 --- a/man/contaminants.Rd +++ b/man/contaminants.Rd @@ -3,7 +3,7 @@ \docType{data} \name{contaminants} \alias{contaminants} -\title{Example dataset of comtamination} +\title{Example dataset of contamination} \format{An object of type \code{\link{taxmap}}} \usage{ contaminants diff --git a/man/diverging_palette.Rd b/man/diverging_palette.Rd index 031c9f8..03b8230 100644 --- a/man/diverging_palette.Rd +++ b/man/diverging_palette.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/heat_tree--mapping.R \name{diverging_palette} \alias{diverging_palette} -\title{The defualt diverging color palette} +\title{The default diverging color palette} \usage{ diverging_palette() } diff --git a/man/extract_taxonomy.Rd b/man/extract_taxonomy.Rd index 74acbf0..a9c99cb 100644 --- a/man/extract_taxonomy.Rd +++ b/man/extract_taxonomy.Rd @@ -39,7 +39,7 @@ Each term must be one of those decribed below: \item{\code{name}}{The name of a taxon. Not necessarily unique, but are interpretable by a particular \code{database}. Requires an internet connection.} \item{\code{taxon_info}}{Arbitrary taxon info you want included in the output. Can be used more than once.} - \item{\code{class}}{A list of taxa information that consitutes the full taxonomic classification + \item{\code{class}}{A list of taxa information that constitutes the full taxonomic classification from broad to specific (see \code{class_rev}) for a particular \code{database}. Individual taxa are separated by the \code{class_sep} argument and the information is parsed by the \code{class_regex} and \code{class_key} arguments.} diff --git a/man/get_numerics.Rd b/man/get_numerics.Rd index a2292ea..8fd3693 100644 --- a/man/get_numerics.Rd +++ b/man/get_numerics.Rd @@ -10,6 +10,6 @@ get_numerics(input) \item{input}{} } \description{ -Returns just valid numeric values and igores others. +Returns just valid numeric values and ignores others. } \keyword{internal} diff --git a/man/heat_tree.Rd b/man/heat_tree.Rd index 2572286..8a005b2 100644 --- a/man/heat_tree.Rd +++ b/man/heat_tree.Rd @@ -71,7 +71,7 @@ Default: constant size.} Default: relative to node size.} \item{node_label_size}{See details on size. -Default: relative to veterx size.} +Default: relative to vertex size.} \item{edge_label_size}{See details on size. Default: relative to edge size.} @@ -188,7 +188,7 @@ Default: 20.} \item{overlap_avoidance}{(\code{numeric}) The relative importance of avoiding overlaps vs maximizing size range. -Higher numbers will cause node size optimazation to avoid overlaps more. +Higher numbers will cause node size optimization to avoid overlaps more. Default: \code{1}.} \item{margin_size}{(\code{numeric} of length 2) @@ -208,7 +208,7 @@ Default: Not used.} \item{title}{Name to print above the graph.} -\item{title_size}{The size of the title realtive to the rest of the graph.} +\item{title_size}{The size of the title relative to the rest of the graph.} \item{node_color_axis_label}{The label on the scale axis corresponding to \code{node_color}. Default: The expression given to \code{node_color}.} @@ -234,7 +234,7 @@ Plots the distribution of values associated with a taxonomic classification. Taxonomic classifications can have multiple roots, resulting in multiple trees on the same plot. Sizes and colors of nodes, edges, labels, and individual trees can be displayed relative to numbers (e.g. taxon statistics, such as abundance). -The displayed range of colors and sizes can be explicitly defined or automatically genereated. +The displayed range of colors and sizes can be explicitly defined or automatically generated. Various transforamtions can be applied to numbers sizes/colors are mapped to. Several types of tree layout algorithms from \code{\link{igraph}} can be used. } @@ -300,7 +300,7 @@ A customized function can also be supplied to do the transformation. \section{ranges}{ -The displayed range of colors and sizes can be explicitly defined or automatically genereated. +The displayed range of colors and sizes can be explicitly defined or automatically generated. Size ranges are specified by supplying a \code{numeric} vector with two values: the minimum and maximum. The units used should be between 0 and 1, representing the proportion of a dimension of the graph. Since the dimensions of the graph are determined by layout, and not always square, the value @@ -327,7 +327,7 @@ The following \code{character} values are understood: \item{"graphopt"}{Use \code{\link[igraph]{with_graphopt}}. A force-directed layout.} \item{"mds"}{Use \code{\link[igraph]{with_mds}}. Multidimensional scaling.} \item{"fruchterman-reingold"}{Use \code{\link[igraph]{with_fr}}. A force-directed layout.} - \item{"kamada-kawai"}{Use \code{\link[igraph]{with_kk}}. A layout based on a phyisical model of springs.} + \item{"kamada-kawai"}{Use \code{\link[igraph]{with_kk}}. A layout based on a physical model of springs.} \item{"large-graph"}{Use \code{\link[igraph]{with_lgl}}. Meant for larger graphs.} \item{"drl"}{Use \code{\link[igraph]{with_drl}}. A force-directed layout.} } @@ -341,7 +341,7 @@ Intervals are specified by supplying a \code{numeric} vector with two values: th These are defined in the same units as element size/color. By default, the minimum and maximum equals the range of the values used to infer size/color. Setting a custom interval is useful for making size/color in multiple graphs correspond to the same statistics, -or setting logical bounderies (such as \code{c(0,1)} for proportions. +or setting logical boundaries (such as \code{c(0,1)} for proportions. Note that this is different from the "range" options, which determine the range of graphed sizes/colors. } diff --git a/man/label_bounds.Rd b/man/label_bounds.Rd index a70aa9d..c2a2b3a 100644 --- a/man/label_bounds.Rd +++ b/man/label_bounds.Rd @@ -18,6 +18,6 @@ label_bounds(label, x, y, height, rotation, just) \item{just}{Justification. e.g. "left-top"} } \description{ -Given a position, size, rotation, and justification of a lable, calculate the bounding box coordinants +Given a position, size, rotation, and justification of a lable, calculate the bounding box coordinates } \keyword{internal} diff --git a/man/layout_functions.Rd b/man/layout_functions.Rd index 413dc0a..bc1e814 100644 --- a/man/layout_functions.Rd +++ b/man/layout_functions.Rd @@ -13,7 +13,7 @@ see all options.} \item{graph}{(\code{igraph}) The graph to generate the layout for.} -\item{intitial_coords}{(\code{matrix}) Initial node layout to bawse new layout off of.} +\item{intitial_coords}{(\code{matrix}) Initial node layout to base new layout off of.} \item{effort}{(\code{numeric} of length 1) The amount of effort to put into layouts. Typically determines the the number of iterations.} diff --git a/man/metacoder.Rd b/man/metacoder.Rd index aeaef52..250fe7a 100644 --- a/man/metacoder.Rd +++ b/man/metacoder.Rd @@ -16,7 +16,7 @@ The goal of the \code{metacoder} package is to provide a set of tools for: \item A set of functions to manipulate taxonomic data modeled after dplyr. \item Visualization of statistics distributed over taxonomic classifications and phylogenies. \item Evaluating potential metabarcoding primers for taxonomic specificity. - \item Evaluating potential metabarcoding loci for taxonomic discrimiation (in development). + \item Evaluating potential metabarcoding loci for taxonomic discrimination (in development). } To accomplish these goals, `metacoder` leverages resources from other R packages, interfaces with @@ -38,7 +38,7 @@ There is also a short vignette included for offline use that can be accessed by \section{Most important functions}{ -\strong{Parseing taxonomy information:} +\strong{Parsing taxonomy information:} \itemize{ \item \code{\link{extract_taxonomy}} diff --git a/man/molten_dist.Rd b/man/molten_dist.Rd index b689748..5e04ec7 100644 --- a/man/molten_dist.Rd +++ b/man/molten_dist.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/heat_tree--vertex_size.R \name{molten_dist} \alias{molten_dist} -\title{Get all distances beween points} +\title{Get all distances between points} \usage{ molten_dist(x, y) } @@ -15,7 +15,7 @@ molten_dist(x, y) A \code{data.frame} } \description{ -Returns the distances bewteen every possible combination of two points. +Returns the distances between every possible combination of two points. } \examples{ \dontrun{ diff --git a/man/parse_hmp_qiime.Rd b/man/parse_hmp_qiime.Rd index 93f8733..cedbd57 100644 --- a/man/parse_hmp_qiime.Rd +++ b/man/parse_hmp_qiime.Rd @@ -19,7 +19,7 @@ parse_hmp_qiime(otu_file, mapping_file, min_abundance = 1, max_otus = -1) A \code{\link{taxmap}} object } \description{ -NOTE: Not extensivley tested +NOTE: Not extensively tested Parses the results of the Human Microbiome Project QIIME analysis of the 16S metagenomic data. This is mostly a wrapper for \code{\link{extract_taxonomy}}. } diff --git a/man/parse_taxonomy_table.Rd b/man/parse_taxonomy_table.Rd index efcd815..c1fdd37 100644 --- a/man/parse_taxonomy_table.Rd +++ b/man/parse_taxonomy_table.Rd @@ -21,7 +21,7 @@ The name of the column can have to following values: Requires an internet connection.} \item{\code{name}}{The name of a taxon. Not necessarily unique, but are interpretable by a particular \code{database}. Requires an internet connection.} - \item{\code{class}}{A list of taxa information that consitutes the full taxonomic classification + \item{\code{class}}{A list of taxa information that constitutes the full taxonomic classification from broad to specific (see \code{class_rev}) for a particular \code{database}. Individual taxa are separated by the \code{class_sep} argument and the information is parsed by the \code{class_regex} and \code{class_key} arguments.} diff --git a/man/primersearch.Rd b/man/primersearch.Rd index b1dfcb2..c833e93 100644 --- a/man/primersearch.Rd +++ b/man/primersearch.Rd @@ -27,7 +27,7 @@ primersearch(input, forward, reverse, mismatch = 5, ...) \item{sequence_col}{(\code{character} of length 1) The name of the column in \code{obs_data} that has the input sequences.} \item{result_cols}{(\code{character}) The names of columns to include in the output. -By defualt, all output columns are included.} +By default, all output columns are included.} } \value{ An object of type \code{\link{taxmap}} diff --git a/man/qualitative_palette.Rd b/man/qualitative_palette.Rd index 273dff6..1990e24 100644 --- a/man/qualitative_palette.Rd +++ b/man/qualitative_palette.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/heat_tree--mapping.R \name{qualitative_palette} \alias{qualitative_palette} -\title{The defualt qualitative color palette} +\title{The default qualitative color palette} \usage{ qualitative_palette() } diff --git a/man/quantative_palette.Rd b/man/quantative_palette.Rd index e621ad9..1fe8af8 100644 --- a/man/quantative_palette.Rd +++ b/man/quantative_palette.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/heat_tree--mapping.R \name{quantative_palette} \alias{quantative_palette} -\title{The defualt quantative color palette} +\title{The default quantative color palette} \usage{ quantative_palette() } diff --git a/man/rdp_ex_data.Rd b/man/rdp_ex_data.Rd index 94150f8..0b1a7da 100644 --- a/man/rdp_ex_data.Rd +++ b/man/rdp_ex_data.Rd @@ -6,7 +6,7 @@ \title{Example of RDP Archea data} \format{An object of type \code{\link{taxmap}}} \source{ -\url{https://rdp.cme.msu.edu/} +\url{http://rdp.cme.msu.edu/} } \usage{ rdp_ex_data diff --git a/man/remove_redundant_names.Rd b/man/remove_redundant_names.Rd index 570b486..d919dee 100644 --- a/man/remove_redundant_names.Rd +++ b/man/remove_redundant_names.Rd @@ -18,6 +18,6 @@ The name of a column in \code{obj$taxon_data}} \code{character} } \description{ -Remove the names of parent taxa in the begining of their children's names in a \code{taxmap} object. +Remove the names of parent taxa in the beginning of their children's names in a \code{taxmap} object. This is useful for removing genus names in binomials. } diff --git a/man/rescale.Rd b/man/rescale.Rd index b5087a7..7c2b1f8 100644 --- a/man/rescale.Rd +++ b/man/rescale.Rd @@ -17,7 +17,7 @@ rescale(x, to = c(0, 1), from = range(x, na.rm = TRUE, finite = TRUE), \item{hard_bounds}{If \code{TRUE}, all values will be forced into the range of \code{to}.} } \description{ -Rescale numeric vector to have specified minimum and maximum, but allow for hard boundries. +Rescale numeric vector to have specified minimum and maximum, but allow for hard boundaries. Light wrapper for scales::rescale } \keyword{internal} diff --git a/man/sample_frac_obs.Rd b/man/sample_frac_obs.Rd index 7b9eae3..cb473b3 100644 --- a/man/sample_frac_obs.Rd +++ b/man/sample_frac_obs.Rd @@ -43,7 +43,7 @@ vector and return a single number.} An object of type \code{\link{taxmap}} } \description{ -Randomly sample some propoortion of observations from a \code{\link{taxmap}} object. Weights can be +Randomly sample some proportion of observations from a \code{\link{taxmap}} object. Weights can be specified for observations or the taxa they are taxmap by. See \link[dplyr]{sample_frac} for the inspiration for this function. } diff --git a/man/sample_frac_taxa.Rd b/man/sample_frac_taxa.Rd index b6c8d5a..604265e 100644 --- a/man/sample_frac_taxa.Rd +++ b/man/sample_frac_taxa.Rd @@ -41,7 +41,7 @@ vector and return a single number.} An object of type \code{\link{taxmap}} } \description{ -Randomly sample some propoortion of taxa from a \code{\link{taxmap}} object. Weights can be +Randomly sample some proportion of taxa from a \code{\link{taxmap}} object. Weights can be specified for taxa or the observations assigned to them. See \link[dplyr]{sample_frac} for the inspiration for this function. } diff --git a/man/subtaxa.Rd b/man/subtaxa.Rd index c2efcf9..53c52a1 100644 --- a/man/subtaxa.Rd +++ b/man/subtaxa.Rd @@ -14,7 +14,7 @@ queried.} \item{subset}{(\code{character}) \code{taxon_ids} or indexes of \code{taxon_data} for which supertaxa will be returned. Default: All taxa in \code{obj} will be used.} -\item{recursive}{(\code{logical}) If \code{FALSE}, only return the subtaxa one level bwlow the +\item{recursive}{(\code{logical}) If \code{FALSE}, only return the subtaxa one level below the target taxa. If \code{TRUE}, return all the subtaxa of every subtaxa, etc.} \item{simplify}{(\code{logical}) If \code{TRUE}, then combine all the results into a single diff --git a/man/validate_regex_key_pair.Rd b/man/validate_regex_key_pair.Rd index 97148de..4cd6f9e 100644 --- a/man/validate_regex_key_pair.Rd +++ b/man/validate_regex_key_pair.Rd @@ -21,7 +21,7 @@ Returns the result of \code{\link{match.arg}} on the key. } \description{ Checks that the number of capture groups in the regex matches the length of the key. -Checks that only certian values of \code{key} can appear more that once. +Checks that only certain values of \code{key} can appear more that once. Adds names to keys that will be used for column names in the output of \code{extract_taxonomy}. Uses non-standard evaluation to get the name of input variables. }