-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1f7cf19
commit 0cfe3c3
Showing
6 changed files
with
169 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
# HELP TEXT | ||
|
||
help_warranty <- function(...) { | ||
tags$p( | ||
"This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY." | ||
) | ||
} | ||
|
||
help_cite <- function(...) { | ||
pkg <- switch ( | ||
get_app_name(), | ||
seriate = "kairos", | ||
source = "nexus", | ||
ternary = "isopleuros", | ||
NULL | ||
) | ||
|
||
list( | ||
tags$p( | ||
"If you use this application in your research, you must report", | ||
"and cite it properly to ensure transparency of your results.", | ||
"Moreover, authors and maintainers of this project are more likely", | ||
"to continue their work if they see that it's being used and valued", | ||
"by the research community." | ||
), | ||
tags$p("To cite in your publications, please use:"), | ||
cite_package(pkg) | ||
) | ||
} | ||
|
||
help_license <- function(...) { | ||
list( | ||
h3("License"), | ||
tags$p( | ||
"This app is distributed as a free and open source", | ||
tags$a("R package", href = url_tesselle("kinesis"), | ||
target = "_blank", rel = "external", .noWS = "after"), "." | ||
), | ||
tags$p( | ||
"You can redistribute it and/or modify it under the terms", | ||
"of the GNU General Public License as published", | ||
"by the Free Software Foundation, either version 3 of the License,", | ||
"or (at your option) any later version." | ||
) | ||
) | ||
} | ||
|
||
help_tesselle <- function(...) { | ||
list( | ||
h3("What is", tags$em("tesselle", .noWS = "after"), "?"), | ||
tags$p( | ||
"This app is a part of the", tags$strong("tesselle"), "project,", | ||
"a collection of packages for research and teaching in archaeology.", | ||
"The", tags$strong("tesselle"), "packages focus on quantitative", | ||
"analysis methods developed for archaeology. They can be used to", | ||
"explore and analyze common data types in archaeology: count data,", | ||
"compositional data and chronological data." | ||
), | ||
tags$p( | ||
"For more information and relevant links see:", | ||
tags$a("tesselle.org", href = url_tesselle(), | ||
target = "_blank", rel = "external", .noWS = "after"), "." | ||
) | ||
# h3("Who is", tags$em("tesselle"), "for?") | ||
) | ||
} | ||
|
||
help_overview <- function(...) { | ||
switch ( | ||
get_app_name(), | ||
source = .help_overview_source(), | ||
tags$p() | ||
) | ||
} | ||
|
||
.help_overview_source <- function(...) { | ||
list( | ||
tags$p( | ||
"Provenance studies rely on the identification of probable sources,", | ||
"such that the variability between two sources is greater than", | ||
"the internal variability of a single source", | ||
"(the so-called", tags$em("provenance postulate", .noWS = "after"), ").", | ||
"This assumes that a unique signature can be identified for each source", | ||
"on the basis of several criteria." | ||
), | ||
tags$p( | ||
"This application is designed for chemical fingerprinting", | ||
"and source tracking of ancient materials. It provides provides tools", | ||
"for the exploration, visualization and analysis of compositional data", | ||
"in the framework of", | ||
cite_article(author = "Aitchison", year = "1986", after = ".") | ||
) | ||
) | ||
} | ||
|
||
help_workflow <- function(...) { | ||
def <- .help_workflow_panel() | ||
tab <- switch ( | ||
get_app_name(), | ||
source = c("Data", "Composition", "Transform", "Statistics", "Plot", "Analysis"), | ||
ternary = c("Data", "Plot"), | ||
"Data" | ||
) | ||
|
||
txt <- def[tab] | ||
# dl <- mapply( | ||
# dt = names(txt), | ||
# dd = txt, | ||
# FUN = function(dt, dd) { list(tags$dt(dt), tags$dd(dd)) } | ||
# ) | ||
# tags$dl(ol) | ||
ol <- mapply( | ||
dt = names(txt), | ||
dd = txt, | ||
FUN = function(dt, dd) { list(tags$li(tags$strong(dt, .noWS = "after"), ".", dd)) } | ||
) | ||
tags$ol(ol) | ||
} | ||
|
||
.help_workflow_panel <- function(...) { | ||
list( | ||
Data = "Import your data and perform basic data cleansing and preparation steps.", | ||
Composition = "Coerce your data to compositions and define (reference) groups.", | ||
Transform = "Compute log-ratio transformations of compositional data.", | ||
Statistics = "Data summary and descriptive statistics.", | ||
Plot = "Visualize your data.", | ||
Analysis = "Perform multivariate data analysis." | ||
) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters