You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#'An example set of sequence meta.data corresponding to alignment.ex
13
11
#'
14
-
#'A dataset describing 10 different HIV1 pol sequences collected in Northern Alberta Cabada.
12
+
#'A dataset describing 10 different HIV1 pol sequences collected in Northern Alberta Canada.
15
13
#'
16
14
#' @format A data.table object with 9 variables:
17
15
#' \describe{
18
-
#' \item{ID}{Accession IDs (characters) of sequences}
19
-
#' \item{CollectionDate}{Collection date of sequences. Full dates given as yyyy-mm-dd}
20
-
#' \item{Subtype}{Subtypes (factors) within a cluster}
16
+
#' \item{ID}{Accession IDs (characters) of sequences}
17
+
#' \item{CollectionDate}{Collection date of sequences. Full dates given as yyyy-mm-dd}
18
+
#' \item{Subtype}{Subtypes (factors) within a cluster}
21
19
#' \item{Header}{The original headers from the alignement. This matches meta data to sequences}
22
-
#' \
23
20
#' }
24
-
"cluster.ex"
25
-
21
+
"seq.info.ex"
26
22
27
23
#'An example set of clusters, built using component.cluster
28
24
#'
@@ -33,15 +29,14 @@
33
29
#' @format A data.table object with 9 variables:
34
30
#' \describe{
35
31
#' \item{ClusterID}{ The unique identifier number for this cluster. A numberic}
36
-
#' \item{ID}{A list of vectors, each containing the accession IDs (characters) of sequences within a cluster}
37
-
#' \item{CollectionDate}{A list of vectors, each containing the collection date of sequences within a cluster}
38
-
#' \item{Subtype}{A list of vectors, each containing the subtypes (factors) within a cluster}
32
+
#' \item{ID}{A list of vectors, each containing the accession IDs (characters) of sequences within a cluster}
33
+
#' \item{CollectionDate}{A list of vectors, each containing the collection date of sequences within a cluster}
34
+
#' \item{Subtype}{A list of vectors, each containing the subtypes (factors) within a cluster}
39
35
#' \item{Header}{A list of vectors, each containing the original headers from the alignement used to build this set of clusters}
40
-
#' \item{Size} {The original size of this cluster before being updated with new cases. This simply the number of sequences within the cluster}
41
-
#' \item{Growth} {The growth of the cluster after new cases are added}
42
-
#' \item{DistThresh} {The pairwise distance threshold used to create this complete set of clusters. Corresponds to a setID as an input parameter}
43
-
#' \item{SetID} {The unique identifier for this set of clusters. A numeric}
44
-
#' \
36
+
#' \item{Size}{The original size of this cluster before being updated with new cases. This simply the number of sequences within the cluster}
37
+
#' \item{Growth}{The growth of the cluster after new cases are added}
38
+
#' \item{DistThresh}{The pairwise distance threshold used to create this complete set of clusters. Corresponds to a setID as an input parameter}
39
+
#' \item{SetID}{The unique identifier for this set of clusters. A numeric}
45
40
#' }
46
41
"cluster.ex"
47
42
@@ -50,7 +45,6 @@
50
45
#'This implementation of a graph is a list, describing a set of sequences and the distances between them.
51
46
#'See create.graph for more information on how this graph was created using alignment.ex as input
52
47
#'
53
-
#'
54
48
#' @format A list of 3 variables
55
49
#' \describe{
56
50
#' \item{seq.info}{ See seq.info.ex, a data.table containing sequence meta data}
@@ -59,7 +53,6 @@
59
53
#' In order to ensure that clusters do not merge upon growth, a new sequence may only
60
54
#' join up to one old cluster. By default, new sequences join the cluster of the
61
55
#' sequence they are most similar to. }
62
-
#' \
63
56
#' }
64
57
"graph.ex"
65
58
@@ -90,13 +83,12 @@
90
83
#' @format A , phylogenetic tree with 6 tips and 4 internal nodes. Node labels represent certainty
91
84
#' See ape's implementation of phylogenetic tree objects for information about tags within this object.
92
85
#' In addition, there are 4 new objects created by functions within tree.setup.R
86
+
#' \describe{
93
87
#' \item{seq.info}{ See seq.info.ex, a data.table containing sequence meta data}
94
-
#' \item{node.info}{ Grouping of the meta.data present in seq.info assigned to various nodes in the tree, coupled with
95
-
#' information important to clustering, such as mean divergence from root, or node certainty }
96
-
#' \item{path.info} { Information regarding the path of edges from tips to the root of the tree. This is also necessary for some clustering algorithms,
97
-
#' specifically step.cluster}
98
-
#' \item{growth.info}{ a data.table pairing new sequences, to a single node in the tree
99
-
#' based on placements assigned by guppy and pplacer.
88
+
#' \item{node.info}{ Grouping of the meta.data present in seq.info assigned to various nodes in the tree,
89
+
#' coupled with information important to clustering, such as mean divergence from root, or node certainty }
90
+
#' \item{path.info}{ Information regarding the path of edges from tips to the root of the tree.
91
+
#' This is also necessary for some clustering algorithms, specifically step.cluster}
92
+
#' \item{growth.info}{ a data.table pairing new sequences, to a single node in the tree based on placements assigned by guppy and pplacer.}
0 commit comments