forked from EMSL-Computing/ftmsRanalysis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_pkgdown.yml
151 lines (150 loc) · 3.75 KB
/
_pkgdown.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
template:
path: "pkgdown-template"
params:
bootswatch: cosmo
#title: FT-MS Data Analysis in R
home:
# strip_header: true
links:
- text: Learn more
href: https://msc-viz.emsl.pnnl.gov
navbar:
structure:
left: [home, intro, reference, articles, news]
right: github
reference:
- title: ftmsData object construction
desc: Functions to construct an ftmsData object
contents:
- '`as.compoundData`'
- '`as.moduleData`'
- '`as.peakData`'
- '`as.reactionData`'
- '`subset.peakData`'
- '`summary.ftmsData`'
- title: Meta data calculation
desc: Functions to calculate meta-data fields
contents:
- '`compound_calcs`'
- '`assign_class`'
- '`assign_elemental_composition`'
- '`assign_mf`'
- title: Filtering
desc: Functions to filter
contents:
- '`applyFilt`'
- '`mass_filter`'
- '`molecule_filter`'
- '`formula_filter`'
- '`emeta_filter`'
- '`plot.formulaFilt`'
- '`plot.massFilt`'
- '`plot.moleculeFilt`'
- '`plot.emetaFilt`'
- '`summary.formulaFilt`'
- '`summary.massFilt`'
- '`summary.moleculeFilt`'
- '`summary.emetaFilt`'
- title: Data transformation
desc: Functions to transform data (e.g. scale)
contents:
- '`edata_replace`'
- '`edata_transform`'
- title: Treatment groups and group comparisons
desc: Defining experimental groups and comparisons
contents:
- '`group_designation`'
- '`comparisonMatrix`'
- '`concat`'
- '`divideByGroup`'
- '`summarizeGroups`'
- '`divideByGroupComparisons`'
- '`divideBySample`'
- '`summarizeGroupComparisons`'
- '`uniqueness_gtest`'
- '`uniqueness_nsamps`'
- '`uniqueness_prop`'
- title: Visualization
desc: Visualization methods
contents:
- '`plot.peakData`'
- '`classesPlot`'
- '`densityPlot`'
- '`kendrickPlot`'
- '`vanKrevelenPlot`'
- '`scatterPlot`'
- '`plotPrincipalCoordinates`'
- '`vignette_interactivity_between_plots`'
- '`panelFunctionGenerator`'
- '`densityCognostics`'
- '`kendrickCognostics`'
- '`vanKrevelenCognostics`'
- title: Database mapping
desc: Functions to map to biological databases
contents:
- '`mapPeaksToCompounds`'
- '`mapCompoundsToReactions`'
- '`mapCompoundsToModules`'
- '`parseModuleReaction`'
- '`combinePeaksWithSameFormula`'
# - '`plotReactionGraph`'
# - '`plotlyHeatmap`'
- title: Convenience methods
desc: ~
contents:
- '`getDataScale`'
- '`getDatabase`'
- '`getGroupDF`'
- '`getGroupSummaryFunctionNames`'
- '`getInstrumentType`'
- '`getModuleName`'
- '`getVanKrevelenCategoryBounds`'
- title: Column name methods
desc: Methods to get the column name used to store various meta data values
contents:
- '`getAromaColName`'
- '`getBS1ColName`'
- '`getBS2ColName`'
- '`getBS3ColName`'
- '`getCarbonColName`'
- '`getCompoundColName`'
- '`getDBEAIColName`'
- '`getDBEColName`'
- '`getDBEoColName`'
- '`getEDataColName`'
- '`getElCompColName`'
- '`getExtractionColName`'
- '`getFDataColName`'
- '`getGibbsColName`'
- '`getHCRatioColName`'
- '`getHydrogenColName`'
- '`getIsotopicColName`'
- '`getKendrickDefectColName`'
- '`getKendrickMassColName`'
- '`getMFColName`'
- '`getMFNameColName`'
- '`getMassColName`'
- '`getModAromaColName`'
- '`getModuleColName`'
- '`getModuleNodeColName`'
- '`getNCRatioColName`'
- '`getNOSCColName`'
- '`getNPRatioColName`'
- '`getNitrogenColName`'
- '`getOCRatioColName`'
- '`getOxygenColName`'
- '`getPCRatioColName`'
- '`getPhosphorusColName`'
- '`getReactionColName`'
- '`getSulfurColName`'
- title: Example data objects
desc: Example data included in the `ftmsRanalysis` package
contents:
- '`examplePeakData`'
- '`exampleProcessedPeakData`'
- '`ftms12T_edata`'
- '`ftms12T_emeta`'
- '`ftms12T_fdata`'
github:
- icon: fa-github
href: https://github.com/EMSL-Computing