add docs, fix #233

Author: sckott

.Rbuildignore

@@ -16,4 +16,5 @@ notes-v2.md
 .github
 ^codemeta\.json$
 ^LICENSE\.md$
-
+^_pkgdown\.yml$
+^docs$

Makefile

@@ -2,13 +2,13 @@ all: move rmd2md
 
 vignettes:
 		cd inst/vign;\
-		Rscript -e 'library(knitr); knit("search.Rmd"); knit("elastic_intro.Rmd")'
+		Rscript -e 'library(knitr); knit("search.Rmd"); knit("elastic.Rmd")'
 
 move:
 		cp inst/vign/search.md vignettes;\
-		cp inst/vign/elastic_intro.md vignettes
+		cp inst/vign/elastic.md vignettes
 
 rmd2md:
 		cd vignettes;\
 		mv search.md search.Rmd;\
-		mv elastic_intro.md elastic_intro.Rmd
+		mv elastic.md elastic.Rmd

R/searchapis.R

@@ -1,4 +1,4 @@
-#' Search functions.
+#' Overview of search functions
 #'
 #' @name searchapis
 #' @details

R/tokenizer_set.R

@@ -6,6 +6,9 @@
 #' @param index (character) A character vector of index names
 #' @param body Query, either a list or json.
 #' @param ... Curl options passed on to [crul::HttpClient]
+#' 
+#' @references 
+#' https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
 #'
 #' @author Scott Chamberlain <myrmecocystus@@gmail.com>
 #' @examples \dontrun{

_pkgdown.yml

@@ -0,0 +1,83 @@
+reference:
+  - title: "elastic"
+    desc: >
+      High level overview of package
+    contents:
+      - elastic
+      - elastic-defunct
+  - title: "Connect"
+    contents:
+      - connect
+      - ping
+  - title: "Cat"
+    contents:
+      - starts_with("cat_")
+  - title: "Search"
+    desc: >
+      Various search APIs
+    contents:
+      - starts_with("Search")
+      - starts_with("search")
+      - msearch
+      - count
+      - explain
+      - validate
+      - field_stats
+      - field_caps
+      - fielddata
+      - percolate
+      - scroll
+      - preference
+  - title: "Documents"
+    desc: >
+      Work with document APIs
+    contents:
+      - starts_with("docs_")
+      - matches("documents")
+      - termvectors
+      - mtermvectors
+  - title: "Indices"
+    desc: >
+      Index APIs
+    contents:
+      - starts_with("index_")
+      - starts_with("alias_")
+      - starts_with("mapping_")
+      - field_mapping_get
+      - type_exists
+      - reindex
+  - title: "Analysis"
+    desc: >
+      Analysis APIs
+    contents:
+      - starts_with("tokenizer_")
+  - title: "Ingest"
+    desc: >
+      Ingest APIs
+    contents:
+      - ingest
+      - starts_with("pipeline_")
+  - title: "Cluster"
+    desc: >
+      Cluster/Nodes APIs
+    contents:
+      - nodes
+      - cluster
+      - tasks
+      - starts_with("nodes_")
+      - starts_with("cluster_")
+      - starts_with("tasks")
+  - title: "Utilities"
+    desc: >
+      Various utility functions
+    contents:
+      - units-distance
+      - units-time
+      - type_remover
+articles:
+  - title: elastic introduction
+    contents:
+    - elastic
+  - title: elastic searching
+    contents:
+    - search