diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2015-07-22 22:43:46 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2015-07-22 22:43:46 +0200 |
| commit | 0942cfd015148bc1850c55c8c7f2819fb62ceda9 (patch) | |
| tree | cd5bc0b66a3fb7b74bee76f2bced07f3c6054f53 | |
| parent | 01174fc65e26876bd5818d005a6204b9b2b593b7 (diff) | |
index.r for grouping help topics in static documentation
| -rw-r--r-- | .Rbuildignore | 1 | ||||
| -rw-r--r-- | GNUmakefile | 8 | ||||
| -rw-r--r-- | NEWS.md | 2 | ||||
| -rw-r--r-- | index.r | 61 |
4 files changed, 67 insertions, 5 deletions
diff --git a/.Rbuildignore b/.Rbuildignore index 3d3ef024..1d3963d1 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -23,3 +23,4 @@ test.log test.R check.log build.log +index.r diff --git a/GNUmakefile b/GNUmakefile index 1766bc11..21dbc738 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -85,15 +85,13 @@ vignettes/%.html: vignettes/mkin_vignettes.css vignettes/%.Rmd vignettes: vignettes/mkin.pdf vignettes/FOCUS_D.html vignettes/FOCUS_L.html vignettes/FOCUS_Z.pdf vignettes/compiled_models.html -sd: install +sd: rm -rf $(SDDIR)/* + cp index.r $(SDDIR) @echo Now execute @echo "\n library(staticdocs); build_site(site_path = '$(SDDIR)')\n" $(RBIN)/R - -sd2: install - rm -rf $(SDDIR)/* - xvfb-run $(RBIN)/R -e "library(staticdocs); build_site(site_path = '$(SDDIR)')" + rm $(SDDIR)/index.r r-forge: sd cd $(SDDIR) && svn add --force . @@ -2,7 +2,9 @@ ## mkin 0.9-40.9000 +### Minor changes +- Use an index.r file to group help topics in static documentation ## mkin 0.9-40 (2015-07-21) diff --git a/index.r b/index.r new file mode 100644 index 00000000..aa82df46 --- /dev/null +++ b/index.r @@ -0,0 +1,61 @@ +sd_section( + "Main functions", + "Essential functionality", + c("mkinmod", "mkinfit", "mmkin") +) +sd_section( + "Show results", + "Functions working on mkinfit objects", + c("plot.mkinfit", + "summary.mkinfit", + "mkinresplot", + "mkinparplot", + "endpoints", + "mkinerrmin") +) +sd_section( + "Work with mmkin objects", + "Functions working with aggregated results", + c("[.mmkin", + "plot.mmkin") +) +sd_section( + "Datasets and known results", + "", + c("FOCUS_2006_datasets", + "FOCUS_2006_SFO_ref_A_to_F", + "FOCUS_2006_FOMC_ref_A_to_F", + "FOCUS_2006_HS_ref_A_to_F", + "FOCUS_2006_DFOP_ref_A_to_B", + "mccall81_245T", + "schaefer07_complex_case", + "synthetic_data_for_UBA_2014" + ) +) +sd_section( + "Helper functions", + "", + c("mkin_wide_to_long", + "mkin_long_to_wide", + "mkinsub", + "mkinpredict", + "transform_odeparms", + "ilr", + "geometric_mean") +) +sd_section( + "Analytical solutions", + "Parent only model solutions", + c("SFO.solution", + "FOMC.solution", + "DFOP.solution", + "SFORB.solution", + "HS.solution", + "IORE.solution" + ) +) +sd_section( + "Deprecated functions", + "Functions that have been superseeded", + c("mkinplot") +) |