(v3.1.0.9003) Rewrite the manual index on the website for findability: sections ordered by task (cleaning data, interpreting results as SIR, analysing data), titles before function names, a filter field that also finds topics mentioning a term, and colours prepared for dark mode; also make the tidymodels extensions public in the manual and use consistent help page titles

This commit is contained in:
dr. M.S. (Matthijs) Berends committed 2026-10-17 09:36:10 +02:00
1 parent 52d9c4a9e7
commit bd208429cd
22 files changed
+524 -128

No files matched your search

+1 -1
View File
@@ -5,7 +5,7 @@
\alias{custom_eucast_rules}
\alias{ab_class}
\alias{ab_selector}
\title{Deprecated Functions, Arguments, or Datasets}
\title{Deprecated Functions, Arguments, or Data Sets}
\usage{
custom_eucast_rules(...)
+1 -1
View File
@@ -2,7 +2,7 @@
% Please edit documentation in R/aa_options.R
\name{AMR-options}
\alias{AMR-options}
\title{Options for the AMR package}
\title{Options for the AMR Package}
\description{
This is an overview of all the package-specific options you can set in the \code{AMR} package. Set them using the \code{\link[=options]{options()}} function, e.g.:
+1 -1
View File
@@ -17,7 +17,7 @@
\alias{ab_info}
\alias{ab_url}
\alias{set_ab_names}
\title{Get Properties of an Antibiotic}
\title{Get Properties of an Antimicrobial Drug}
\usage{
ab_name(x, language = get_AMR_locale(), tolower = FALSE, ...)
-1
View File
@@ -147,4 +147,3 @@ if (require("tidymodels")) {
\seealso{
\code{\link[recipes:recipe]{recipes::recipe()}}, \code{\link[=as.sir]{as.sir()}}, \code{\link[=as.mic]{as.mic()}}, \code{\link[=as.disk]{as.disk()}}
}
\keyword{internal}
+1 -1
View File
@@ -6,7 +6,7 @@
\alias{is.ab}
\alias{ab_reset_session}
\alias{NA_ab_}
\title{Transform Input to an Antibiotic ID}
\title{Transform Input to an Antimicrobial Drug ID}
\usage{
as.ab(
x,
+1 -1
View File
@@ -2,7 +2,7 @@
% Please edit documentation in R/guess_ab_col.R
\name{guess_ab_col}
\alias{guess_ab_col}
\title{Guess Antibiotic Column}
\title{Guess Antimicrobial Column}
\usage{
guess_ab_col(
x = NULL,
+1 -1
View File
@@ -3,7 +3,7 @@
\name{italicise_taxonomy}
\alias{italicise_taxonomy}
\alias{italicize_taxonomy}
\title{Italicise Taxonomic Families, Genera, Species, Subspecies}
\title{Italicise Taxonomic Families, Genera, Species, and Subspecies}
\usage{
italicise_taxonomy(string, type = c("markdown", "ansi", "html"))
+1 -1
View File
@@ -5,7 +5,7 @@
\alias{random_mic}
\alias{random_disk}
\alias{random_sir}
\title{Random MIC Values/Disk Zones/SIR Generation}
\title{Generate Random MIC Values, Disk Zones, or SIR Results}
\usage{
random_mic(
size = NULL,