## ----message=FALSE----------------------------------------------------------------------------------------------------
library(crunch)

## ----results='hide', include = FALSE----------------------------------------------------------------------------------
set_crunch_opts("crunch.api" = "https://team.crunch.io/api/")
library(httptest)
run_cleanup <- !dir.exists("crunch")
httpcache::clearCache()
start_vignette("crunch")

## ----usethis, eval=FALSE----------------------------------------------------------------------------------------------
# if (!require("usethis")) install.packages("usethis")
# # Note: After running this command, R may ask you one or two questions.
# # While you likely *do* want to update the dependency packages, you likely
# # *do not* want to install any package from source, so you can answer something
# # like "update all packages from CRAN" if it asks which packages to update,
# # and "No" if it asks you to install from source.
# usethis::edit_r_environ()

## ----reload_environ, eval=FALSE---------------------------------------------------------------------------------------
# readRenviron("~/.Renviron")

## ----sitrep-code, eval=FALSE------------------------------------------------------------------------------------------
# crunch_sitrep()

## ----sitrep-display, echo=FALSE---------------------------------------------------------------------------------------
message(paste0(
    "crunch API: https://your-brand.crunch.io/api/\n",
    "            (found in environment variable `R_CRUNCH_API`)\n",
    "       key: abcdefghi***************************************\n",
    "            (found in environment variable `R_CRUNCH_API_KEY`)"
))

## ----project----------------------------------------------------------------------------------------------------------
my_project <- newProject("examples/rcrunch vignette data")

## ----dimensions-------------------------------------------------------------------------------------------------------
dim(SO_survey)

## ----load dataset, message=FALSE--------------------------------------------------------------------------------------
ds <- newDataset(SO_survey, name="Stack Overflow Developer Survey 2017", project=my_project)
dim(ds)

## ----get dataset description------------------------------------------------------------------------------------------
name(ds)
description(ds)

## ----state change2, include=FALSE-------------------------------------------------------------------------------------
change_state()

## ----set description--------------------------------------------------------------------------------------------------
description(ds) <- "Subset of the main survey, restricted to self-reported R users"
description(ds)

## ----variable examples------------------------------------------------------------------------------------------------
ds$TabsSpaces
ds[, "CompanySize"]

## ----state change3, include=FALSE-------------------------------------------------------------------------------------
change_state()

## ----variable descriptions--------------------------------------------------------------------------------------------
descriptions(variables(ds)) <- SO_schema$Question
description(ds$CompanySize)

## ----open variable, eval = FALSE--------------------------------------------------------------------------------------
# webApp(ds$CompanySize)

## ----open variable screen, echo = FALSE-------------------------------------------------------------------------------
knitr::include_graphics("images/crunch-companySize-screen.png")

## ----categorical arrays-----------------------------------------------------------------------------------------------
ds$ImportantHiringCompanies
ds$ImportantHiringAlgorithms

## ----grep subvars-----------------------------------------------------------------------------------------------------
imphire <- grep("^ImportantHiring", names(ds), value = TRUE)
imphire

## ----state change4, include=FALSE-------------------------------------------------------------------------------------
change_state()

## ----makeArray--------------------------------------------------------------------------------------------------------
ds$ImportantHiring <- makeArray(ds[imphire], name = "Importance in Hiring Process")

## ---------------------------------------------------------------------------------------------------------------------
subvariables(ds$ImportantHiring)

## ----state change5, include=FALSE-------------------------------------------------------------------------------------
change_state()

## ---------------------------------------------------------------------------------------------------------------------
description(ds$ImportantHiring) <- sub("^(.*\\?).*$", "\\1",
    descriptions(subvariables(ds$ImportantHiring))[1])
names(subvariables(ds$ImportantHiring)) <- sub("^.*\\? (.*)$", "\\1",
    descriptions(subvariables(ds$ImportantHiring)))

subvariables(ds$ImportantHiring)

## ----View array, eval = FALSE-----------------------------------------------------------------------------------------
# webApp(ds$ImportantHiring)

## ----View array screen, echo = FALSE----------------------------------------------------------------------------------
knitr::include_graphics("images/crunch-importantHiringCA.png")

## ---------------------------------------------------------------------------------------------------------------------
knitr::kable(SO_survey[1:5, "HaveWorkedLanguage", drop = FALSE], row.names = FALSE)

## ----state change6, include=FALSE-------------------------------------------------------------------------------------
change_state()

## ----makeMRFromText---------------------------------------------------------------------------------------------------
ds$WantWorkLanguageMR <- makeMRFromText(ds$WantWorkLanguage,
    delim = "; ",
    name = "Languages Desired for Work",
    description = description(ds$WantWorkLanguage))

## ----MR table---------------------------------------------------------------------------------------------------------
table(ds$WantWorkLanguageMR)

## ----reorder subvariables---------------------------------------------------------------------------------------------
counts <- sort(table(ds$WantWorkLanguageMR), decreasing = TRUE)
subvariables(ds$WantWorkLanguageMR) <- subvariables(ds$WantWorkLanguageMR)[names(counts)]

## ----echo = FALSE-----------------------------------------------------------------------------------------------------
knitr::include_graphics("images/WantWorkMRReodered.png")

## ----include=FALSE----------------------------------------------------------------------------------------------------
end_vignette()
if (run_cleanup) {
    with_consent(delete(ds))
    with_consent(delete(my_project))
}