From f0120eee116549210b68c71ee2f952a5120cf51e Mon Sep 17 00:00:00 2001 From: ernestguevarra <5742010+ernestguevarra@users.noreply.github.com> Date: Wed, 18 Dec 2024 23:21:17 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20rapidsur?= =?UTF-8?q?veys/okapi@661f696c5e84d8133da22661efa65ba49716a443=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev/authors.html | 10 ++++-- dev/index.html | 51 +++++++++++++++------------ dev/pkgdown.yml | 2 +- dev/reference/ona_form_delete.html | 2 +- dev/reference/ona_org_delete.html | 2 +- dev/reference/ona_project_delete.html | 2 +- dev/search.json | 2 +- 7 files changed, 41 insertions(+), 30 deletions(-) diff --git a/dev/authors.html b/dev/authors.html index 6459ba4..6249ba8 100644 --- a/dev/authors.html +++ b/dev/authors.html @@ -43,13 +43,17 @@

Authors

Citation

Source: inst/CITATION

-

Ernest Guevarra (2023). okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools R package version 0.1.0.9000 URL https://rapidsurveys.io/okapi/

+

Ernest Guevarra (2024). +okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools. +doi:10.5281/zenodo.206914853, R package version 0.0.0.9000, https://rapidsurveys.io/okapi/. +

@Manual{,
   title = {okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools},
   author = {{Ernest Guevarra}},
-  year = {2023},
-  note = {R package version 0.1.0.9000},
+  year = {2024},
+  note = {R package version 0.0.0.9000},
   url = {https://rapidsurveys.io/okapi/},
+  doi = {10.5281/zenodo.206914853},
 }
diff --git a/dev/index.html b/dev/index.html index b2c6fd2..56ba47e 100644 --- a/dev/index.html +++ b/dev/index.html @@ -61,19 +61,14 @@ -

Data collection using computer-assisted personal interviewing or CAPI tools is now the standard approach for conducting surveys and studies. A wide range of CAPI systems are currently being used. The ability to interface with these systems helps in the overall data process. This package provides interface functions to CAPI systems based on the Open Data Kit or ODK technology.

-
-

Motivation and development history -

-
-
-

The ODK ecosystem -

-
+

Data collection using computer-assisted personal interviewing (CAPI) tools is now the standard approach for conducting surveys and studies. A wide range of CAPI systems are currently being used. The ability to interface with these systems helps in the overall data process. This package provides interface functions to CAPI systems based on the Open Data Kit (ODK) technology.

+

What does the package do?

-

Currently, okapi provides functions to interface with two ODK-based systems: ONA and KoboToolbox via their respective APIs. The current set of functions perform the following tasks:

+

Currently, okapi provides functions to interface with ONA via its API. The current set of functions perform the following tasks:

  1. Authenticate with the respective servers using either an account password or an API token;

  2. List resources in the server available to interface with; and,

    3. @@ -83,20 +78,28 @@

    What does the package do?

    Installation

    -

    okapi is not yet available on CRAN.

    -

    You can install okapi from the RapidSurveys R Universe with:

    +

    okapi is not yet on CRAN but can be installed from the RapidSurveys R Universe with:

     install.packages(
   "okapi", 
-  repos = c(
-    'https://rapidsurveys.r-universe.dev', 
-    'https://cloud.r-project.org'
-  )
+  repos = c('https://rapidsurveys.r-universe.dev', 'https://cloud.r-project.org')
 )

Usage

+
+

Authentication +

+
+
+

List resources +

+
+
+

Retrieve resources +

+

Citation @@ -106,18 +109,21 @@

Citationcitation("okapi") #> To cite okapi in publications use: #> -#> Ernest Guevarra (2023). okapi: Open Data Kit (ODK)-based -#> Computer-assisted Personal Interview (CAPI) Tools R package -#> version 0.1.0.9000 URL https://rapidsurveys.io/okapi/ +#> Ernest Guevarra (2024). _okapi: Open Data Kit (ODK)-based +#> Computer-assisted Personal Interview (CAPI) Tools_. +#> doi:10.5281/zenodo.206914853 +#> <https://doi.org/10.5281/zenodo.206914853>, R package +#> version 0.0.0.9000, <https://rapidsurveys.io/okapi/>. #> #> A BibTeX entry for LaTeX users is #> #> @Manual{, #> title = {okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools}, #> author = {{Ernest Guevarra}}, -#> year = {2023}, -#> note = {R package version 0.1.0.9000}, +#> year = {2024}, +#> note = {R package version 0.0.0.9000}, #> url = {https://rapidsurveys.io/okapi/}, +#> doi = {10.5281/zenodo.206914853}, #> }

@@ -170,12 +176,13 @@

Developers

Dev status

diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index ace9860..276d207 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.1 pkgdown_sha: ~ articles: {} -last_built: 2024-12-18T16:48Z +last_built: 2024-12-18T23:21Z urls: reference: https://rapidsurveys.io/okapi/reference article: https://rapidsurveys.io/okapi/articles diff --git a/dev/reference/ona_form_delete.html b/dev/reference/ona_form_delete.html index aad6803..0a09a8f 100644 --- a/dev/reference/ona_form_delete.html +++ b/dev/reference/ona_form_delete.html @@ -72,7 +72,7 @@

Examplesform_id <- form_list[["formid"]][form_list[["title"]] == "Appearance Widgets"] ona_form_delete(form_id = form_id) #> Response [https://api.ona.io/api/v1/forms/] -#> Date: 2024-12-18 16:49 +#> Date: 2024-12-18 23:21 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB diff --git a/dev/reference/ona_org_delete.html b/dev/reference/ona_org_delete.html index 05c7b9a..ee41384 100644 --- a/dev/reference/ona_org_delete.html +++ b/dev/reference/ona_org_delete.html @@ -72,7 +72,7 @@

Examplesorg_name <- org_list[["org"]] ona_org_delete(org = org_name) #> Response [https://api.ona.io/api/v1/orgs/] -#> Date: 2024-12-18 16:49 +#> Date: 2024-12-18 23:21 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB diff --git a/dev/reference/ona_project_delete.html b/dev/reference/ona_project_delete.html index 5f6281b..6c0f682 100644 --- a/dev/reference/ona_project_delete.html +++ b/dev/reference/ona_project_delete.html @@ -72,7 +72,7 @@

Examplesproject_id <- project_list[["projectid"]] ona_project_delete(project_id = project_id) #> Response [https://api.ona.io/api/v1/projects/] -#> Date: 2024-12-18 16:49 +#> Date: 2024-12-18 23:21 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB diff --git a/dev/search.json b/dev/search.json index 3dcbbac..ac4e5a4 100644 --- a/dev/search.json +++ b/dev/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement contact@katilingban.io. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https:// www.contributor-covenant.org/translations.","code":""},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/CONTRIBUTING.html","id":"bugs","dir":"","previous_headings":"","what":"Bugs","title":"Contributing","text":"Submit issue issues page","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CONTRIBUTING.html","id":"code-contributions","dir":"","previous_headings":"","what":"Code contributions","title":"Contributing","text":"Fork repository Github account Clone version account machine account Make sure track progress upstream .e., version okapi rapidsurveys/okapi, making changes make sure pull changes upstream either git fetch upstream merge later git pull upstream fetch merge one step Make changes new feature branch Please write test tests changes affect code just documentation Push changes account Submit pull request rapidsurveys/okapi","code":"git clone https://github.com//okapi.git git remote add upstream https://github.com/rapidsurveys/okapi.git"},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc.  Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see . GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read .","code":" Copyright (C) 2019 Ernest Guevarra This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . odktools Copyright (C) 2019 Ernest Guevarra This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"https://rapidsurveys.io/okapi/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Ernest Guevarra. Author, maintainer.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ernest Guevarra (2023). okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools R package version 0.1.0.9000 URL https://rapidsurveys.io/okapi/","code":"@Manual{, title = {okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools}, author = {{Ernest Guevarra}}, year = {2023}, note = {R package version 0.1.0.9000}, url = {https://rapidsurveys.io/okapi/}, }"},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"okapi-open-data-kit-odk-based-computer-assisted-personal-interview-capi-tools-","dir":"","previous_headings":"","what":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"Data collection using computer-assisted personal interviewing CAPI tools now standard approach conducting surveys studies. wide range CAPI systems currently used. ability interface systems helps overall data process. package provides interface functions CAPI systems based Open Data Kit ODK technology.","code":""},{"path":[]},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"what-does-the-package-do","dir":"","previous_headings":"","what":"What does the package do?","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"Currently, okapi provides functions interface two ODK-based systems: ONA KoboToolbox via respective APIs. current set functions perform following tasks: Authenticate respective servers using either account password API token; List resources server available interface ; , Get data resources server R.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"okapi yet available CRAN. can install okapi RapidSurveys R Universe :","code":"install.packages( \"okapi\", repos = c( 'https://rapidsurveys.r-universe.dev', 'https://cloud.r-project.org' ) )"},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"use okapi work, please cite using suggested citation provided call citation function follows:","code":"citation(\"okapi\") #> To cite okapi in publications use: #> #> Ernest Guevarra (2023). okapi: Open Data Kit (ODK)-based #> Computer-assisted Personal Interview (CAPI) Tools R package #> version 0.1.0.9000 URL https://rapidsurveys.io/okapi/ #> #> A BibTeX entry for LaTeX users is #> #> @Manual{, #> title = {okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools}, #> author = {{Ernest Guevarra}}, #> year = {2023}, #> note = {R package version 0.1.0.9000}, #> url = {https://rapidsurveys.io/okapi/}, #> }"},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"community-guidelines","dir":"","previous_headings":"","what":"Community guidelines","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"Feedback, bug reports feature requests welcome; file issues seek support . like contribute package, please see contributing guidelines. project released Contributor Code Conduct. participating project agree abide terms.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"Basic authentication KoBo Toolbox username password","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"","code":"kobo_auth_password(username, password = askpass::askpass())"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"username KoBo Toolbox username. password KoBo Toolbox password. Default interactive input password.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"System environment variables KOBO_KF_USERNAME KOBO_KF_PASSWORD","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"","code":"kobo_auth_password(username = Sys.getenv(\"KOBO_USERNAME\"), password = Sys.getenv(\"KOBO_PASSWORD\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"Basic authentication KoBo Toolbox API authentication token","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"","code":"kobo_auth_token(token)"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"token KoBo Toolbox API authentication token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"System environment variables KOBO_KF_TOKEN","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"","code":"kobo_auth_token(token = Sys.getenv(\"KOBO_TOKEN\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve specific dataset by form ID from specific user — kobo_get_data","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"Retrieve specific dataset form ID specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"","code":"kobo_get_data( base_url = \"https://kf.kobotoolbox.org\", auth_mode = \"token\", asset_id )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"base_url KoBo Toolbox URL. Default https://kf.kobotoolbox.org. auth_mode Password token? Default token. asset_id Unique asset identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"tibble datasets available specific user.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"","code":"kobo_auth_token(token = Sys.getenv(\"KOBO_TOKEN\")) kobo_get_data(asset_id = \"aKJTpKiVUcPYim2epKkPvW\") #> # A tibble: 1 × 1 #> x #> #> 1 "},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve list of assets available to specific user — kobo_list_assets","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"Retrieve list assets available specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"","code":"kobo_list_assets(base_url = \"https://kf.kobotoolbox.org\", auth_mode = \"token\")"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"base_url KoBo Toolbox URL. Default https://kf.kobotoolbox.org. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"list assets available specific user.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"","code":"kobo_auth_token(token = Sys.getenv(\"KOBO_TOKEN\")) kobo_list_assets() #> # A tibble: 0 × 0"},{"path":"https://rapidsurveys.io/okapi/dev/reference/okapi.html","id":null,"dir":"Reference","previous_headings":"","what":"Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools — okapi","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools — okapi","text":"Data collection using computer-assisted personal interviewing CAPI tools now standard approach conducting surveys studies. wide range CAPI systems currently used. ability interface systems helps overall data process. package provides interface functions CAPI systems based Open Data Kit ODK technology.","code":""},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/reference/okapi.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools — okapi","text":"Maintainer: Ernest Guevarra ernest@guevarra.io (ORCID)","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to ONA with a username and password — ona_auth_password","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"Basic authentication ONA username password","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"","code":"ona_auth_password(username, password = askpass::askpass())"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"username ONA username. password ONA password. Default interactive input password.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"System environment variables ONA_USERNAME ONA_PASSWORD","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"","code":"ona_auth_password(username = Sys.getenv(\"ONA_USERNAME\"), password = Sys.getenv(\"ONA_PASSWORD\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to ONA with API authentication token — ona_auth_token","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"Basic authentication ONA API authentication token","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"","code":"ona_auth_token(token)"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"token ONA API authentication token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"System environment variables ONA_TOKEN","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"","code":"ona_auth_token(token = Sys.getenv(\"ONA_TOKEN\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":null,"dir":"Reference","previous_headings":"","what":"Configure HTTP headers — ona_configure","title":"Configure HTTP headers — ona_configure","text":"Configure HTTP headers","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Configure HTTP headers — ona_configure","text":"","code":"ona_configure(auth_mode = c(\"token\", \"password\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Configure HTTP headers — ona_configure","text":"auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Configure HTTP headers — ona_configure","text":"object class request HTTP requests","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve specific dataset by form ID from specific user — ona_data_get","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"Retrieve specific dataset form ID specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"","code":"ona_data_get( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), form_id )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. form_id Form identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"tibble retrieved dataset.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"","code":"ona_data_get(form_id = 276175) #> # A tibble: 1 × 1 #> x #> #> 1 "},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve list of datasets available to specific user — ona_data_list","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"Retrieve list datasets available specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"","code":"ona_data_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"tibble datasets available specific user.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"","code":"ona_data_list() #> # A tibble: 1 × 1 #> x #> #> 1 "},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete published form — ona_form_delete","title":"Delete published form — ona_form_delete","text":"Delete published form","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete published form — ona_form_delete","text":"","code":"ona_form_delete( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), form_id = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete published form — ona_form_delete","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. form_id Form identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete published form — ona_form_delete","text":"Delete specified form ONA.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete published form — ona_form_delete","text":"","code":"form_list <- ona_form_list() form_id <- form_list[[\"formid\"]][form_list[[\"title\"]] == \"Appearance Widgets\"] ona_form_delete(form_id = form_id) #> Response [https://api.ona.io/api/v1/forms/] #> Date: 2024-12-18 16:49 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB #> #> #> #> #> api.ona.io<\/title> #> <meta name=\"description\" content=\"Mobile data collection made easy. formh... #> <meta name=\"author\" content=\"\"> #> #> <meta name=\"google-site-verification\" content=\"H0JRFrqLHnVfHuZaHRfz1Gmc5f... #> #> ..."},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List published forms — ona_form_list","title":"List published forms — ona_form_list","text":"List published forms","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List published forms — ona_form_list","text":"","code":"ona_form_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List published forms — ona_form_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List published forms — ona_form_list","text":"tibble published forms.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List published forms — ona_form_list","text":"","code":"ona_form_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":null,"dir":"Reference","previous_headings":"","what":"Publish XLSForm — ona_form_publish","title":"Publish XLSForm — ona_form_publish","text":"Publish XLSForm","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Publish XLSForm — ona_form_publish","text":"","code":"ona_form_publish( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), xls_file = NULL, xls_url = NULL, dropbox_xls_url = NULL, project_id = NULL, public = FALSE )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Publish XLSForm — ona_form_publish","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. xls_file Path XLSForm file. xls_url URL XLSForm file. dropbox_xls_url Dropbox URL XLSForm file. project_id Project identifier project publish XLSForm . NULL (default), XLSForm published account's default project. public Logical. form public? Default FALSE.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Publish XLSForm — ona_form_publish","text":"published form ONA.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Publish XLSForm — ona_form_publish","text":"","code":"project_list <- ona_project_list() if (\"test\" %in% project_list$name) { project_id = project_list$id[project_list$name == \"test\"] ona_project_delete(project_id = project_id) } #> Warning: Unknown or uninitialised column: `name`. ona_project_register(name = \"test\") #> $detail #> [1] \"Invalid token header. No credentials provided.\" #> project_list <- ona_project_list() project_id = project_list$id[project_list$name == \"test\"] #> Warning: Unknown or uninitialised column: `id`. #> Warning: Unknown or uninitialised column: `name`. ona_form_publish( xls_file = system.file( \"appearance_widgets.xlsx\", package = \"okapi\" ), project_id = project_id ) #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete registered organisation — ona_org_delete","title":"Delete registered organisation — ona_org_delete","text":"Delete registered organisation","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete registered organisation — ona_org_delete","text":"","code":"ona_org_delete( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), org )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete registered organisation — ona_org_delete","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. org Organisation short name username.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete registered organisation — ona_org_delete","text":"Delete specified organisation specific ONA account.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete registered organisation — ona_org_delete","text":"","code":"org_list <- ona_org_list() org_name <- org_list[[\"org\"]] ona_org_delete(org = org_name) #> Response [https://api.ona.io/api/v1/orgs/] #> Date: 2024-12-18 16:49 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB #> <!DOCTYPE html> #> <html lang=\"en\"> #> <head> #> <meta charset=\"utf-8\"> #> <title>api.ona.io<\/title> #> <meta name=\"description\" content=\"Mobile data collection made easy. formh... #> <meta name=\"author\" content=\"\"> #> #> <meta name=\"google-site-verification\" content=\"H0JRFrqLHnVfHuZaHRfz1Gmc5f... #> #> ..."},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List organisations — ona_org_list","title":"List organisations — ona_org_list","text":"List organisations","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List organisations — ona_org_list","text":"","code":"ona_org_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List organisations — ona_org_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List organisations — ona_org_list","text":"tibble organisations.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List organisations — ona_org_list","text":"","code":"ona_org_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":null,"dir":"Reference","previous_headings":"","what":"Register an organisation — ona_org_register","title":"Register an organisation — ona_org_register","text":"Register organisation","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Register an organisation — ona_org_register","text":"","code":"ona_org_register( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), org, name = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Register an organisation — ona_org_register","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. org Organisation short name username. name Organisation full name. NULL (default), short name used.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Register an organisation — ona_org_register","text":"Invisible. Organisation registered created ONA account","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Register an organisation — ona_org_register","text":"","code":"ona_org_register(org = \"okapi_organisation\") #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete registered project — ona_project_delete","title":"Delete registered project — ona_project_delete","text":"Delete registered project","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete registered project — ona_project_delete","text":"","code":"ona_project_delete( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), project_id = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete registered project — ona_project_delete","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. project_id Project identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete registered project — ona_project_delete","text":"Delete specified project specific ONA account.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete registered project — ona_project_delete","text":"","code":"project_list <- ona_project_list() project_id <- project_list[[\"projectid\"]] ona_project_delete(project_id = project_id) #> Response [https://api.ona.io/api/v1/projects/] #> Date: 2024-12-18 16:49 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB #> <!DOCTYPE html> #> <html lang=\"en\"> #> <head> #> <meta charset=\"utf-8\"> #> <title>api.ona.io<\/title> #> <meta name=\"description\" content=\"Mobile data collection made easy. formh... #> <meta name=\"author\" content=\"\"> #> #> <meta name=\"google-site-verification\" content=\"H0JRFrqLHnVfHuZaHRfz1Gmc5f... #> #> ..."},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get project info — ona_project_info","title":"Get project info — ona_project_info","text":"Get project info","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get project info — ona_project_info","text":"","code":"ona_project_info( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), project_id = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get project info — ona_project_info","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. project_id Project identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get project info — ona_project_info","text":"tibble projects.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get project info — ona_project_info","text":"","code":"ona_project_info(project_id = 12345) #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List projects — ona_project_list","title":"List projects — ona_project_list","text":"List projects","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List projects — ona_project_list","text":"","code":"ona_project_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List projects — ona_project_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List projects — ona_project_list","text":"tibble projects.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List projects — ona_project_list","text":"","code":"ona_project_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":null,"dir":"Reference","previous_headings":"","what":"Register a project — ona_project_register","title":"Register a project — ona_project_register","text":"Register project","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Register a project — ona_project_register","text":"","code":"ona_project_register( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), owner = Sys.getenv(\"ONA_USERNAME\"), name = NULL, public = TRUE )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Register a project — ona_project_register","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. owner Username organisation name creating project. Default username currently authenticated account (via `Sys.getenv(ONA_USERNAME)`). organisation name, organisation currently authenticated account owner admin user. name Name project. NULL (default), project given default name similar created ONA forms published without project public Logical. project public? Default TRUE.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Register a project — ona_project_register","text":"Invisible. Project registered created ONA account","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Register a project — ona_project_register","text":"","code":"ona_project_register() #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":null,"dir":"Reference","previous_headings":"","what":"Share projects with user(s) — ona_project_share","title":"Share projects with user(s) — ona_project_share","text":"Share projects user(s)","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Share projects with user(s) — ona_project_share","text":"","code":"ona_project_share( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), project_id = NULL, username = NULL, role = c(\"readonly\", \"dataentry\", \"editor\", \"manager\"), email = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Share projects with user(s) — ona_project_share","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. project_id Project identifier. username character value vector username/s user/s share form . role character value role user/s project. can *readonly*, *dataentry*, *editor*, *manager*. email Email message send user/s project shared . NULL (default), user/s notified.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Share projects with user(s) — ona_project_share","text":"Invisible. Project shared specified users specified roles. tibble project information.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Share projects with user(s) — ona_project_share","text":"","code":"ona_project_share( project_id = 12345, username = \"validtrial\", role = \"readonly\" ) #> # A tibble: 1 × 2 #> forms users #> <list> <list> #> 1 <NULL> <NULL>"}] +[{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement contact@katilingban.io. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https:// www.contributor-covenant.org/translations.","code":""},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/CONTRIBUTING.html","id":"bugs","dir":"","previous_headings":"","what":"Bugs","title":"Contributing","text":"Submit issue issues page","code":""},{"path":"https://rapidsurveys.io/okapi/dev/CONTRIBUTING.html","id":"code-contributions","dir":"","previous_headings":"","what":"Code contributions","title":"Contributing","text":"Fork repository Github account Clone version account machine account Make sure track progress upstream .e., version okapi rapidsurveys/okapi, making changes make sure pull changes upstream either git fetch upstream merge later git pull upstream fetch merge one step Make changes new feature branch Please write test tests changes affect code just documentation Push changes account Submit pull request rapidsurveys/okapi","code":"git clone https://github.com/<yourgithubusername>/okapi.git git remote add upstream https://github.com/rapidsurveys/okapi.git"},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"https://rapidsurveys.io/okapi/dev/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see <http://www.gnu.org/licenses/>. GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read <http://www.gnu.org/philosophy/--lgpl.html>.","code":"<one line to give the program's name and a brief idea of what it does.> Copyright (C) 2019 Ernest Guevarra This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. odktools Copyright (C) 2019 Ernest Guevarra This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"https://rapidsurveys.io/okapi/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Ernest Guevarra. Author, maintainer.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ernest Guevarra (2024). okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools. doi:10.5281/zenodo.206914853, R package version 0.0.0.9000, https://rapidsurveys.io/okapi/.","code":"@Manual{, title = {okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools}, author = {{Ernest Guevarra}}, year = {2024}, note = {R package version 0.0.0.9000}, url = {https://rapidsurveys.io/okapi/}, doi = {10.5281/zenodo.206914853}, }"},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"okapi-open-data-kit-odk-based-computer-assisted-personal-interview-capi-tools-","dir":"","previous_headings":"","what":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"Data collection using computer-assisted personal interviewing (CAPI) tools now standard approach conducting surveys studies. wide range CAPI systems currently used. ability interface systems helps overall data process. package provides interface functions CAPI systems based Open Data Kit (ODK) technology.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"what-does-the-package-do","dir":"","previous_headings":"","what":"What does the package do?","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"Currently, okapi provides functions interface ONA via API. current set functions perform following tasks: Authenticate respective servers using either account password API token; List resources server available interface ; , Get data resources server R.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"okapi yet CRAN can installed RapidSurveys R Universe :","code":"install.packages( \"okapi\", repos = c('https://rapidsurveys.r-universe.dev', 'https://cloud.r-project.org') )"},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"use okapi work, please cite using suggested citation provided call citation function follows:","code":"citation(\"okapi\") #> To cite okapi in publications use: #> #> Ernest Guevarra (2024). _okapi: Open Data Kit (ODK)-based #> Computer-assisted Personal Interview (CAPI) Tools_. #> doi:10.5281/zenodo.206914853 #> <https://doi.org/10.5281/zenodo.206914853>, R package #> version 0.0.0.9000, <https://rapidsurveys.io/okapi/>. #> #> A BibTeX entry for LaTeX users is #> #> @Manual{, #> title = {okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools}, #> author = {{Ernest Guevarra}}, #> year = {2024}, #> note = {R package version 0.0.0.9000}, #> url = {https://rapidsurveys.io/okapi/}, #> doi = {10.5281/zenodo.206914853}, #> }"},{"path":"https://rapidsurveys.io/okapi/dev/index.html","id":"community-guidelines","dir":"","previous_headings":"","what":"Community guidelines","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interviewing (CAPI) Tools","text":"Feedback, bug reports feature requests welcome; file issues seek support . like contribute package, please see contributing guidelines. project released Contributor Code Conduct. participating project agree abide terms.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"Basic authentication KoBo Toolbox username password","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"","code":"kobo_auth_password(username, password = askpass::askpass())"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"username KoBo Toolbox username. password KoBo Toolbox password. Default interactive input password.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"System environment variables KOBO_KF_USERNAME KOBO_KF_PASSWORD","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_password.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to KoBo Toolbox with a username and password — kobo_auth_password","text":"","code":"kobo_auth_password(username = Sys.getenv(\"KOBO_USERNAME\"), password = Sys.getenv(\"KOBO_PASSWORD\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"Basic authentication KoBo Toolbox API authentication token","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"","code":"kobo_auth_token(token)"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"token KoBo Toolbox API authentication token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"System environment variables KOBO_KF_TOKEN","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_auth_token.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to KoBo Toolbox with API authentication token — kobo_auth_token","text":"","code":"kobo_auth_token(token = Sys.getenv(\"KOBO_TOKEN\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve specific dataset by form ID from specific user — kobo_get_data","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"Retrieve specific dataset form ID specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"","code":"kobo_get_data( base_url = \"https://kf.kobotoolbox.org\", auth_mode = \"token\", asset_id )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"base_url KoBo Toolbox URL. Default https://kf.kobotoolbox.org. auth_mode Password token? Default token. asset_id Unique asset identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"tibble datasets available specific user.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_get_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve specific dataset by form ID from specific user — kobo_get_data","text":"","code":"kobo_auth_token(token = Sys.getenv(\"KOBO_TOKEN\")) kobo_get_data(asset_id = \"aKJTpKiVUcPYim2epKkPvW\") #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve list of assets available to specific user — kobo_list_assets","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"Retrieve list assets available specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"","code":"kobo_list_assets(base_url = \"https://kf.kobotoolbox.org\", auth_mode = \"token\")"},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"base_url KoBo Toolbox URL. Default https://kf.kobotoolbox.org. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"list assets available specific user.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/kobo_list_assets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve list of assets available to specific user — kobo_list_assets","text":"","code":"kobo_auth_token(token = Sys.getenv(\"KOBO_TOKEN\")) kobo_list_assets() #> # A tibble: 0 × 0"},{"path":"https://rapidsurveys.io/okapi/dev/reference/okapi.html","id":null,"dir":"Reference","previous_headings":"","what":"Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools — okapi","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools — okapi","text":"Data collection using computer-assisted personal interviewing CAPI tools now standard approach conducting surveys studies. wide range CAPI systems currently used. ability interface systems helps overall data process. package provides interface functions CAPI systems based Open Data Kit ODK technology.","code":""},{"path":[]},{"path":"https://rapidsurveys.io/okapi/dev/reference/okapi.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools — okapi","text":"Maintainer: Ernest Guevarra ernest@guevarra.io (ORCID)","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to ONA with a username and password — ona_auth_password","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"Basic authentication ONA username password","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"","code":"ona_auth_password(username, password = askpass::askpass())"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"username ONA username. password ONA password. Default interactive input password.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"System environment variables ONA_USERNAME ONA_PASSWORD","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_password.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to ONA with a username and password — ona_auth_password","text":"","code":"ona_auth_password(username = Sys.getenv(\"ONA_USERNAME\"), password = Sys.getenv(\"ONA_PASSWORD\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Basic authentication to ONA with API authentication token — ona_auth_token","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"Basic authentication ONA API authentication token","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"","code":"ona_auth_token(token)"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"token ONA API authentication token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"System environment variables ONA_TOKEN","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_auth_token.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Basic authentication to ONA with API authentication token — ona_auth_token","text":"","code":"ona_auth_token(token = Sys.getenv(\"ONA_TOKEN\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":null,"dir":"Reference","previous_headings":"","what":"Configure HTTP headers — ona_configure","title":"Configure HTTP headers — ona_configure","text":"Configure HTTP headers","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Configure HTTP headers — ona_configure","text":"","code":"ona_configure(auth_mode = c(\"token\", \"password\"))"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Configure HTTP headers — ona_configure","text":"auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_configure.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Configure HTTP headers — ona_configure","text":"object class request HTTP requests","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve specific dataset by form ID from specific user — ona_data_get","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"Retrieve specific dataset form ID specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"","code":"ona_data_get( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), form_id )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. form_id Form identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"tibble retrieved dataset.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve specific dataset by form ID from specific user — ona_data_get","text":"","code":"ona_data_get(form_id = 276175) #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve list of datasets available to specific user — ona_data_list","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"Retrieve list datasets available specific user","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"","code":"ona_data_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"tibble datasets available specific user.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_data_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve list of datasets available to specific user — ona_data_list","text":"","code":"ona_data_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete published form — ona_form_delete","title":"Delete published form — ona_form_delete","text":"Delete published form","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete published form — ona_form_delete","text":"","code":"ona_form_delete( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), form_id = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete published form — ona_form_delete","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. form_id Form identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete published form — ona_form_delete","text":"Delete specified form ONA.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete published form — ona_form_delete","text":"","code":"form_list <- ona_form_list() form_id <- form_list[[\"formid\"]][form_list[[\"title\"]] == \"Appearance Widgets\"] ona_form_delete(form_id = form_id) #> Response [https://api.ona.io/api/v1/forms/] #> Date: 2024-12-18 23:21 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB #> <!DOCTYPE html> #> <html lang=\"en\"> #> <head> #> <meta charset=\"utf-8\"> #> <title>api.ona.io<\/title> #> <meta name=\"description\" content=\"Mobile data collection made easy. formh... #> <meta name=\"author\" content=\"\"> #> #> <meta name=\"google-site-verification\" content=\"H0JRFrqLHnVfHuZaHRfz1Gmc5f... #> #> ..."},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List published forms — ona_form_list","title":"List published forms — ona_form_list","text":"List published forms","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List published forms — ona_form_list","text":"","code":"ona_form_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List published forms — ona_form_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List published forms — ona_form_list","text":"tibble published forms.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List published forms — ona_form_list","text":"","code":"ona_form_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":null,"dir":"Reference","previous_headings":"","what":"Publish XLSForm — ona_form_publish","title":"Publish XLSForm — ona_form_publish","text":"Publish XLSForm","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Publish XLSForm — ona_form_publish","text":"","code":"ona_form_publish( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), xls_file = NULL, xls_url = NULL, dropbox_xls_url = NULL, project_id = NULL, public = FALSE )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Publish XLSForm — ona_form_publish","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. xls_file Path XLSForm file. xls_url URL XLSForm file. dropbox_xls_url Dropbox URL XLSForm file. project_id Project identifier project publish XLSForm . NULL (default), XLSForm published account's default project. public Logical. form public? Default FALSE.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Publish XLSForm — ona_form_publish","text":"published form ONA.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_form_publish.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Publish XLSForm — ona_form_publish","text":"","code":"project_list <- ona_project_list() if (\"test\" %in% project_list$name) { project_id = project_list$id[project_list$name == \"test\"] ona_project_delete(project_id = project_id) } #> Warning: Unknown or uninitialised column: `name`. ona_project_register(name = \"test\") #> $detail #> [1] \"Invalid token header. No credentials provided.\" #> project_list <- ona_project_list() project_id = project_list$id[project_list$name == \"test\"] #> Warning: Unknown or uninitialised column: `id`. #> Warning: Unknown or uninitialised column: `name`. ona_form_publish( xls_file = system.file( \"appearance_widgets.xlsx\", package = \"okapi\" ), project_id = project_id ) #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete registered organisation — ona_org_delete","title":"Delete registered organisation — ona_org_delete","text":"Delete registered organisation","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete registered organisation — ona_org_delete","text":"","code":"ona_org_delete( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), org )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete registered organisation — ona_org_delete","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. org Organisation short name username.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete registered organisation — ona_org_delete","text":"Delete specified organisation specific ONA account.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete registered organisation — ona_org_delete","text":"","code":"org_list <- ona_org_list() org_name <- org_list[[\"org\"]] ona_org_delete(org = org_name) #> Response [https://api.ona.io/api/v1/orgs/] #> Date: 2024-12-18 23:21 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB #> <!DOCTYPE html> #> <html lang=\"en\"> #> <head> #> <meta charset=\"utf-8\"> #> <title>api.ona.io<\/title> #> <meta name=\"description\" content=\"Mobile data collection made easy. formh... #> <meta name=\"author\" content=\"\"> #> #> <meta name=\"google-site-verification\" content=\"H0JRFrqLHnVfHuZaHRfz1Gmc5f... #> #> ..."},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List organisations — ona_org_list","title":"List organisations — ona_org_list","text":"List organisations","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List organisations — ona_org_list","text":"","code":"ona_org_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List organisations — ona_org_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List organisations — ona_org_list","text":"tibble organisations.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List organisations — ona_org_list","text":"","code":"ona_org_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":null,"dir":"Reference","previous_headings":"","what":"Register an organisation — ona_org_register","title":"Register an organisation — ona_org_register","text":"Register organisation","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Register an organisation — ona_org_register","text":"","code":"ona_org_register( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), org, name = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Register an organisation — ona_org_register","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. org Organisation short name username. name Organisation full name. NULL (default), short name used.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Register an organisation — ona_org_register","text":"Invisible. Organisation registered created ONA account","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_org_register.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Register an organisation — ona_org_register","text":"","code":"ona_org_register(org = \"okapi_organisation\") #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete registered project — ona_project_delete","title":"Delete registered project — ona_project_delete","text":"Delete registered project","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete registered project — ona_project_delete","text":"","code":"ona_project_delete( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), project_id = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete registered project — ona_project_delete","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. project_id Project identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete registered project — ona_project_delete","text":"Delete specified project specific ONA account.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_delete.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete registered project — ona_project_delete","text":"","code":"project_list <- ona_project_list() project_id <- project_list[[\"projectid\"]] ona_project_delete(project_id = project_id) #> Response [https://api.ona.io/api/v1/projects/] #> Date: 2024-12-18 23:21 #> Status: 404 #> Content-Type: text/html; charset=utf-8 #> Size: 4.58 kB #> <!DOCTYPE html> #> <html lang=\"en\"> #> <head> #> <meta charset=\"utf-8\"> #> <title>api.ona.io<\/title> #> <meta name=\"description\" content=\"Mobile data collection made easy. formh... #> <meta name=\"author\" content=\"\"> #> #> <meta name=\"google-site-verification\" content=\"H0JRFrqLHnVfHuZaHRfz1Gmc5f... #> #> ..."},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Get project info — ona_project_info","title":"Get project info — ona_project_info","text":"Get project info","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get project info — ona_project_info","text":"","code":"ona_project_info( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), project_id = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get project info — ona_project_info","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. project_id Project identifier.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get project info — ona_project_info","text":"tibble projects.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get project info — ona_project_info","text":"","code":"ona_project_info(project_id = 12345) #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":null,"dir":"Reference","previous_headings":"","what":"List projects — ona_project_list","title":"List projects — ona_project_list","text":"List projects","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List projects — ona_project_list","text":"","code":"ona_project_list( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\") )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List projects — ona_project_list","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List projects — ona_project_list","text":"tibble projects.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List projects — ona_project_list","text":"","code":"ona_project_list() #> # A tibble: 1 × 1 #> x #> <named list> #> 1 <chr [1]>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":null,"dir":"Reference","previous_headings":"","what":"Register a project — ona_project_register","title":"Register a project — ona_project_register","text":"Register project","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Register a project — ona_project_register","text":"","code":"ona_project_register( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), owner = Sys.getenv(\"ONA_USERNAME\"), name = NULL, public = TRUE )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Register a project — ona_project_register","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. owner Username organisation name creating project. Default username currently authenticated account (via `Sys.getenv(ONA_USERNAME)`). organisation name, organisation currently authenticated account owner admin user. name Name project. NULL (default), project given default name similar created ONA forms published without project public Logical. project public? Default TRUE.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Register a project — ona_project_register","text":"Invisible. Project registered created ONA account","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_register.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Register a project — ona_project_register","text":"","code":"ona_project_register() #> $detail #> [1] \"Invalid token header. No credentials provided.\" #>"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":null,"dir":"Reference","previous_headings":"","what":"Share projects with user(s) — ona_project_share","title":"Share projects with user(s) — ona_project_share","text":"Share projects user(s)","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Share projects with user(s) — ona_project_share","text":"","code":"ona_project_share( base_url = \"https://api.ona.io\", auth_mode = c(\"token\", \"password\"), project_id = NULL, username = NULL, role = c(\"readonly\", \"dataentry\", \"editor\", \"manager\"), email = NULL )"},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Share projects with user(s) — ona_project_share","text":"base_url ONA URL. Default https://api.ona.io. auth_mode Password token? Default token. project_id Project identifier. username character value vector username/s user/s share form . role character value role user/s project. can *readonly*, *dataentry*, *editor*, *manager*. email Email message send user/s project shared . NULL (default), user/s notified.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Share projects with user(s) — ona_project_share","text":"Invisible. Project shared specified users specified roles. tibble project information.","code":""},{"path":"https://rapidsurveys.io/okapi/dev/reference/ona_project_share.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Share projects with user(s) — ona_project_share","text":"","code":"ona_project_share( project_id = 12345, username = \"validtrial\", role = \"readonly\" ) #> # A tibble: 1 × 2 #> forms users #> <list> <list> #> 1 <NULL> <NULL>"}]