{"Package":"civis","Title":"R Client for the 'Civis Platform API'","Version":"3.0.0","Authors@R":"c(\nperson(\"Patrick\", \"Miller\", email = \"pmiller@civisanalytics.com\", role = c(\"cre\", \"aut\")),\nperson(\"Keith\", \"Ingersoll\", email = \"kingersoll@civisanalytics.com\", role = \"aut\"),\nperson(\"Bill\", \"Lattner\", email = \"wlattner@civisanalytics.com\", role = \"ctb\"),\nperson(\"Anh\", \"Le\", email = \"ale@civisanalytics.com\", role = \"ctb\"),\nperson(\"Michelangelo\", \"D'Agostino\", email = \"mdagostino@civisanalytics.com\", role = \"ctb\"),\nperson(\"Sam\", \"Weiss\", email = \"sweiss@civisanalytics.com\", role = \"ctb\"),\nperson(\"Stephen\", \"Hoover\", email = \"shoover@civisanalytics.com\", role = \"ctb\"),\nperson(\"Danning\", \"Chen\", email = \"dchen@civisanalytics.com\", role = \"ctb\"),\nperson(\"Elizabeth\", \"Sander\", email = \"lsander@civisanalytics.com\", role = \"ctb\"),\nperson(\"Madison\", \"Hobbs\", email = \"mhobbs@g.hmc.edu\", role = \"ctb\"),\nperson(\"Anna\", \"Bladey\", email = \"abladey@civisanalytics.com\", role = \"ctb\"),\nperson(\"Sahil\", \"Shah\", email = \"sshah2@civisanalytics.com\", role = \"ctb\"))","Description":"A convenient interface for making\nrequests directly to the 'Civis Platform API' .\nFull documentation available 'here' .","Depends":"R (>= 3.2.0)","License":"BSD_3_clause + file LICENSE","LazyData":"true","URL":"https://github.com/civisanalytics/civis-r","BugReports":"https://github.com/civisanalytics/civis-r/issues","Imports":"future (>= 1.8.0), httr, jsonlite, methods, memoise, stats,\nutils","Suggests":"feather, ggplot2, knitr, rmarkdown, roxygen2, mockery,\nR.utils, rstudioapi, testthat, yaml","RoxygenNote":"7.1.0","VignetteBuilder":"knitr","Collate":"'await.R' 'civis_future.R' 'civis_ml.R' 'civis_ml_plot.R'\n'civis_ml_utils.R' 'civis_ml_workflows.R' 'client_base.R'\n'generate_client.R' 'generated_client.R' 'io.R' 'logs.R'\n'pagination_helpers.R' 'reports.R' 'rstudio.R' 'scripts.R'\n'tables.R' 'utils.R' 'zzz.R'","Encoding":"UTF-8","NeedsCompilation":"no","Packaged":"2020-06-22 17:22:15 UTC; pmiller","Author":"Patrick Miller [cre, aut],\nKeith Ingersoll [aut],\nBill Lattner [ctb],\nAnh Le [ctb],\nMichelangelo D'Agostino [ctb],\nSam Weiss [ctb],\nStephen Hoover [ctb],\nDanning Chen [ctb],\nElizabeth Sander [ctb],\nMadison Hobbs [ctb],\nAnna Bladey [ctb],\nSahil Shah [ctb]","Maintainer":"Patrick Miller ","Repository":"CRAN","Date/Publication":"2020-06-22 18:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/civis_3.0.0.tar.gz","jsonAuthors":[{"name":"Patrick Miller","email":"pmiller@civisanalytics.com","maintainer":true},{"name":"Keith Ingersoll","email":"kingersoll@civisanalytics.com","maintainer":false},{"name":"Bill Lattner","email":"wlattner@civisanalytics.com","maintainer":false},{"name":"Anh Le","email":"ale@civisanalytics.com","maintainer":false},{"name":"Michelangelo D'Agostino","email":"mdagostino@civisanalytics.com","maintainer":false},{"name":"Sam Weiss","email":"sweiss@civisanalytics.com","maintainer":false},{"name":"Stephen Hoover","email":"shoover@civisanalytics.com","maintainer":false},{"name":"Danning Chen","email":"dchen@civisanalytics.com","maintainer":false},{"name":"Elizabeth Sander","email":"lsander@civisanalytics.com","maintainer":false},{"name":"Madison Hobbs","email":"mhobbs@g.hmc.edu","maintainer":false},{"name":"Anna Bladey","email":"abladey@civisanalytics.com","maintainer":false},{"name":"Sahil Shah","email":"sshah2@civisanalytics.com","maintainer":false}],"readme":"Civis Platform API R Client\n================\n[![Build Status](https://travis-ci.org/civisanalytics/civis-r.svg?branch=master)](https://travis-ci.org/civisanalytics/civis-r)\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/civis)](https://cran.r-project.org/package=civis)\n\n## Introduction\n\n`civis` is an R package that helps analysts and developers interact with\nthe Civis Platform. The package includes a set of tools around common\nworkflows as well as a convenient interface to make requests directly to\nthe Civis Platform API.\n\n\n## Documentation\n\nThe full documentation is hosted [here](https://civisanalytics.github.io/civis-r). The fastest way to get started is with the [getting started guide](https://civisanalytics.github.io/civis-r/articles/quick_start.html).\n\n## API Keys\n\nInstalling and using `civis` requires an API key. Instructions\nfor creating an API key can be found [here](https://civis.zendesk.com/hc/en-us/articles/216341583-Generating-an-API-Key).\nAll API keys have a set expiration date and so a new key will need to be\ncreated at least every 30 days.\n\nOnce you have created an API key, you will then need to add it to your\n`.Renviron` so the `civis` package can access it.\n\n#### Linux/MacOS\n\n```bash\ntouch ~/.Renviron\nopen -t ~/.Renviron\n```\n\nThen add the following line replacing the fake key `sadf8sadf9jasdf` with the API key from your Civis Platform Profile:\n\n```\nCIVIS_API_KEY=sadf8sadf9jasdf\n```\nAfter saving the `.Renviron` file, you'll need to restart R/Rstudio.\n\n#### Windows\n\nA `.Renviron` file can be created in the R user home directory, `Sys.getenv(\"R_USER\")`. Typically this is `\"C:/username/Documents\"`. Open or create `.Renviron` with `notepad` and add the key as above. Save with type `all files`, not `.txt`. Restart R/Rstudio.\n\n:heavy_exclamation_mark: You must keep your API key secret. If you use version\ncontrol tools, ensure you do not commit `.Renviron` or any scripts in which\nyou have hard-coded an API key.\n\n\n## Install\n\n```r\n# Default install\ninstall.packages(\"civis\")\n\n# All features (including CivisML)\ninstall.packages(\"civis\", depends = TRUE)\n```\n\n### Updating\n\nThe `civis` package can automatically generate R functions and documentation to interact with the Civis Platform when the package installs.\n\nFrom time to time, new API functions are added. These can be obtained immediately by installing the package from source:\n\n```r\ninstall.packages('civis', depends = TRUE, type = 'source')\n```\n\n## Usage\n\n`civis` includes functionality for both\n\n1. Making single calls to accomplish a specific task (which may involve\nmaking multiple calls to the API)\n2. Making direct calls to the API\n\nMany useful tasks will require making multiple direct calls to the API.\n`civis` includes a number of wrapper functions to make common tasks like IO\nand modeling easier. For example, reading data from a table in\nPlatform is as easy as\n\n```r\nlibrary(civis)\n\n# Read an entire table in to memory\nmy_table <- \"schema.tablename\"\ndf <- read_civis(my_table, database=\"my_database\")\n\n# Run a query and read the results into memory\nquery <- sql(\"SELECT a, b, c FROM schema.tablename WHERE b > 42\")\ndf2 <- read_civis(query, database=\"my_database\")\n```\n\n`civis` includes many more functions for tasks like writing data to tables\nand files as well as for creating reports. For more detailed documentation,\nsee the included vignettes:\n\n```r\nbrowseVignettes('civis')\n```\n\n### Direct calls to API\n\nFunctions which make direct calls to the API are prefixed with the name of the\nresource that the function accesses. For example, the `users` resource\nencapsulates all the functionality of Platform regarding users. We can make\nvarious calls to the `users` resource to get information about ourselves and our\nteam.\n\n```r\n# Data about me\ncivis::users_list_me()\n\n\nList of 14\n $ id : int 971\n $ name : chr \"A User\"\n $ email : chr \"a_user@example.com\"\n $ username : chr \"a_user\"\n $ initials : chr \"AU\"\n# ...\n```\n\n```r\n# Data about my team\nmy_team <- civis::users_list()\nteam_members <- sapply(my_team, function(x) x$name)\nprint(team_members)\n\n[1] \"Jean-Luc Picard\" \"Beverly Crusher\" \"Q\"\n```\n\n## API Documentation\n\n[https://platform.civisanalytics.com/api](https://platform.civisanalytics.com/api)\n\n\n## Contributing\n\nContributions to the code are very welcome! Issues and bug reports can filed through the standard Github issue interface.\n\n### git-flow\n\n1. Fork the repo, make changes in your branch.\n2. Unit tests must pass, and can be run with `devtools::test()` or `cmd-shift-t` in Rstudio.\n3. New code must be backed with tests, mocking all API calls.\n4. `R CMD check` must pass, i.e. using `devtools::check()`.\n5. Make a pull request from the fork to the master branch of the main repo. In your pull request, link to the issue the pull request addresses.\n6. Tag a maintainer for review. Once it has been approved, squash and merge!\n\nAdding the environment variable `R_CLIENT_DEV = \"TRUE\"` to `.Renviron` will prevent new API functions and documentation from being generated based on your API Key. The default generated API functions included in the package are only updated when this package releases to CRAN.\n\n### Integration tests\n\nFor major, potentially breaking changes, integration tests should be run with\n```bash\ncd tools/integration_tests\nRscript smoke_test.R\n```\nNote, integration tests require a valid API key to run, and my be slow.\n\n\n### Authorship\n\nAll contributors of code should include themselves in `DESCRIPTION` by adding\nthe following object in the `Authors@R` section:\n\n```r\nperson(\"FirstName\", \"LastName\", email = \"email@email.com\", role = \"ctb\")\n```\n\nThis project is intended to be a safe, welcoming space for collaboration, and\ncontributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.","jobInfo":{"package":"civis","version":"3.0.0","parsingStatus":"success","parserVersion":2,"parsedAt":"2023-02-23T00:30:46+0000"}}

Description

Usage

Arguments

Value