diff --git a/README.md b/README.md index 026a53a..9e31d35 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # uptasticsearch -[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version-last-release/uptasticsearch)](http://cran.r-project.org/package=uptasticsearch) [![CRAN\_Download\_Badge](http://cranlogs.r-pkg.org/badges/grand-total/uptasticsearch)](http://cran.rstudio.com/web/packages/uptasticsearch/index.html) +[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version-last-release/uptasticsearch)](https://cran.r-project.org/package=uptasticsearch) [![CRAN\_Download\_Badge](https://cranlogs.r-pkg.org/badges/grand-total/uptasticsearch)](https://cran.r-project.org/package=uptasticsearch) ## Introduction diff --git a/r-pkg/DESCRIPTION b/r-pkg/DESCRIPTION index 7b95e3b..cc3d682 100644 --- a/r-pkg/DESCRIPTION +++ b/r-pkg/DESCRIPTION @@ -1,7 +1,7 @@ Package: uptasticsearch Type: Package Title: Get Data Frame Representations of 'Elasticsearch' Results -Version: 0.0.2.9999 +Version: 0.1.0.9999 Authors@R: c( person("James", "Lamb", email = "james.lamb@uptake.com", role = c("aut", "cre")), person("Nick", "Paras", email = "nick.paras@uptake.com", role = c("aut")), diff --git a/r-pkg/NEWS.md b/r-pkg/NEWS.md index 8423920..981e86e 100644 --- a/r-pkg/NEWS.md +++ b/r-pkg/NEWS.md @@ -2,6 +2,21 @@ ## Features +### Elasticsearch metadata +- `get_fields` returns a data.table with the names and types of all indexed fields across one or more indices + +### Routing Temporary File Writing +- `es_search` now accepts an `intermediates_dir` parameter, giving users control over the directory used for temporary I/O at query time + +## Bugfixes + +### Empty Results +- Added logic to short-circuit and return early with an informative message if a query matches 0 documents + +# uptasticsearch 0.0.2 + +## Features + ### Main function - `es_search` executes an ES query and gets a data.table diff --git a/r-pkg/README.md b/r-pkg/README.md index 0f51616..dd737e4 100644 --- a/r-pkg/README.md +++ b/r-pkg/README.md @@ -1,6 +1,6 @@ # uptasticsearch -[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version-last-release/uptasticsearch)](http://cran.r-project.org/package=uptasticsearch) [![CRAN\_Download\_Badge](http://cranlogs.r-pkg.org/badges/grand-total/uptasticsearch)](http://cran.rstudio.com/web/packages/uptasticsearch/index.html) +[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version-last-release/uptasticsearch)](https://cran.r-project.org/package=uptasticsearch) [![CRAN\_Download\_Badge](https://cranlogs.r-pkg.org/badges/grand-total/uptasticsearch)](https://cran.r-project.org/package=uptasticsearch) ## Introduction diff --git a/r-pkg/_pkgdown.yml b/r-pkg/_pkgdown.yml index 197dc6c..013639c 100644 --- a/r-pkg/_pkgdown.yml +++ b/r-pkg/_pkgdown.yml @@ -11,6 +11,7 @@ reference: - starts_with("chomp_") - title: Utilities contents: + - get_fields - unpack_nested_data - parse_date_time - title: Exploratory functions diff --git a/r-pkg/cran-comments.md b/r-pkg/cran-comments.md index 93397c3..352afb1 100644 --- a/r-pkg/cran-comments.md +++ b/r-pkg/cran-comments.md @@ -26,4 +26,46 @@ ## v0.0.2 - Submission 3 - (July 18, 2017) ### CRAN Response -* No lingering issues. v0.0.2 released to CRAN! \ No newline at end of file +* No lingering issues. v0.0.2 released to CRAN! + +## v0.1.0 - Submission 1 - (August 28, 2017) + +### R CMD check results +* No issues + +### CRAN Response +* Need to use CRAN canonical form (http://cran.r-project.org/package=uptasticsearch) + +## v0.1.0 - Submission 2 - (August 28, 2017) + +### R CMD check results +* No issues + +### CRAN Response +* CRAN canonical form uses HTTPS (https://cran.r-project.org/package=uptasticsearch) + +## v0.1.0 - Submission 3 - (August 29, 2017) + +### R CMD check results +* No issues + +### CRAN Response +* CRAN URLs are still missing HTTPS (submitter error) + +## v0.1.0 - Submission 4 - (August 29, 2017) + +### R CMD check results +* No issues + +### CRAN Response +* Still missing HTTPS in CRAN URLs (we'd been editing the README at the repo root, not the one built with the package) +* Reviewers asked if examples in "\dontrun" could be run instead + +## v0.1.0 - Submission 5 - (August 29, 2017) + +### R CMD check results +* No issues + +### CRAN Response +* No lingering issues. v0.0.2 released to CRAN! + diff --git a/r-pkg/docs/authors.html b/r-pkg/docs/authors.html index 83e7568..1a9d919 100644 --- a/r-pkg/docs/authors.html +++ b/r-pkg/docs/authors.html @@ -99,12 +99,16 @@

Authors

Austin Dickey. Author.

+
  • +

    Michael Frasco. Contributor. +

    +

  • Weiwen Gu. Contributor.

  • -

    Uptake Technologies Inc.. Copyright holder. +

    Uptake Technologies Inc.. Copyright holder.

    • diff --git a/r-pkg/docs/index.html b/r-pkg/docs/index.html index 8582df8..b06b045 100644 --- a/r-pkg/docs/index.html +++ b/r-pkg/docs/index.html @@ -369,8 +369,8 @@

    Developers

    Dev status

    diff --git a/r-pkg/docs/news/index.html b/r-pkg/docs/news/index.html index ce73336..c893d28 100644 --- a/r-pkg/docs/news/index.html +++ b/r-pkg/docs/news/index.html @@ -94,6 +94,41 @@

    Features

    +
    +

    +Elasticsearch metadata

    +
      +
    • +get_fields returns a data.table with the names and types of all indexed fields across one or more indices
      • +
    +
    +
    +

    +Routing Temporary File Writing

    +
      +
    • +es_search now accepts an intermediates_dir parameter, giving users control over the directory used for temporary I/O at query time
      • +
    +
    +
    +
    +

    +Bugfixes

    +
    +

    +Empty Results

    +
      +
    • Added logic to short-circuit and return early with an informative message if a query matches 0 documents
      • +
    +
    +
    + +
    +

    +uptasticsearch 0.0.2

    +
    +

    +Features

    Main function

    @@ -140,6 +175,7 @@

    Contents

    diff --git a/r-pkg/docs/reference/chomp_hits.html b/r-pkg/docs/reference/chomp_hits.html index f334e4f..3d3815f 100644 --- a/r-pkg/docs/reference/chomp_hits.html +++ b/r-pkg/docs/reference/chomp_hits.html @@ -126,8 +126,8 @@

    Examp "film":"Avengers: Infinity War","pmt_amount":12.75}]}}}]' # Chomp into a data.table -sampleChompedDT <- chomp_hits(hits_json = result, keep_nested_data_cols = TRUE) -print(sampleChompedDT)

    #> timestamp cust_name details.cust_class details.location +sampleChompedDT <- chomp_hits(hits_json = result, keep_nested_data_cols = TRUE)
    #> INFO [2017-08-30 20:00:04] Keeping the following nested data columns. Consider using unpack_nested_data for one: +#> details.pastPurchases
    print(sampleChompedDT)
    #> timestamp cust_name details.cust_class details.location #> 1: 2017-01-01 Austin big_spender chicago #> 2: 2017-02-02 James peasant chicago #> 3: 2017-03-03 Nick critic cannes diff --git a/r-pkg/docs/reference/get_fields.html b/r-pkg/docs/reference/get_fields.html new file mode 100644 index 0000000..6cfa7f6 --- /dev/null +++ b/r-pkg/docs/reference/get_fields.html @@ -0,0 +1,152 @@ + + + + + + + + +Get the names and data types of the indexed fields in an index — get_fields • uptasticsearch + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    Get the names and data types of the indexed fields in an index

    +
    + + +

    For a given Elasticsearch index, return the mapping from field name + to data type for all indexed fields.

    + + + 
    get_fields(es_host, es_indices = "_all")
    + +

    Arguments

    + + + + + + + + + + +
    es_host

    A string identifying an Elasticsearch host. This should be of +the form [transfer_protocol][hostname]:[port]. For example, +'http://myindex.thing.com:9200'.

    es_indices

    A character vector that contains the names of indices for +which to get mappings. Default is '_all', which means +get the mapping for all indices. Names of indices can be +treated as regular expressions.

    + +

    Value

    + +

    A data.table containing four columns: index, type, field, and data_type

    + + +

    Examples

    + 
    # NOT RUN {
+# get the mapping for all indexed fields in the ticket_sales and customers indices
+mappingDT <- retrieve_mapping(es_host = "http://es.custdb.mycompany.com:9200"
+                              , es_indices = c("ticket_sales", "customers"))
+# }
    +
    + +
    + +
    +
    +

    Developed by James Lamb, Nick Paras, Austin Dickey.

    +
    + +
    +

    Site built with pkgdown.

    +
    + +
    +
    + + + diff --git a/r-pkg/docs/reference/index.html b/r-pkg/docs/reference/index.html index 4847929..228659f 100644 --- a/r-pkg/docs/reference/index.html +++ b/r-pkg/docs/reference/index.html @@ -85,7 +85,7 @@

    Reference - version 0.0.2.9999 + version 0.1.0.9999

    @@ -139,6 +139,12 @@

    + + +

    get_fields

    + +

    Get the names and data types of the indexed fields in an index

    +

    unpack_nested_data

    diff --git a/r-pkg/docs/reference/unpack_nested_data.html b/r-pkg/docs/reference/unpack_nested_data.html index 63670ce..ae3982a 100644 --- a/r-pkg/docs/reference/unpack_nested_data.html +++ b/r-pkg/docs/reference/unpack_nested_data.html @@ -128,8 +128,8 @@

    Examp "film":"Avengers: Infinity War","pmt_amount":12.75}]}}}]' # Chomp into a data.table -sampleChompedDT <- chomp_hits(hits_json = result, keep_nested_data_cols = TRUE) -print(sampleChompedDT)

    #> timestamp cust_name details.cust_class details.location +sampleChompedDT <- chomp_hits(hits_json = result, keep_nested_data_cols = TRUE)
    #> INFO [2017-08-30 20:00:06] Keeping the following nested data columns. Consider using unpack_nested_data for one: +#> details.pastPurchases
    print(sampleChompedDT)
    #> timestamp cust_name details.cust_class details.location #> 1: 2017-01-01 Austin big_spender chicago #> 2: 2017-02-02 James peasant chicago #> 3: 2017-03-03 Nick critic cannes