Package: ckanr 0.9.1
Florian Mayer
ckanr: Client for the Comprehensive Knowledge Archive Network ('CKAN')
Client for the Comprehensive Knowledge Archive Network ('CKAN') application programming interface ('API') (<https://ckan.org/>). Includes interface to 'CKAN' 'APIs' for search, list, show for packages, organizations, and resources. In addition, provides an interface to the 'datastore' extension.
Authors:
ckanr_0.9.1.tar.gz
ckanr_0.9.1.zip(r-4.7-any)ckanr_0.9.1.zip(r-4.6-any)ckanr_0.9.1.zip(r-4.5-any)
ckanr_0.9.1.tgz(r-4.6-any)ckanr_0.9.1.tgz(r-4.5-any)
ckanr_0.9.1.tar.gz(r-4.7-any)ckanr_0.9.1.tar.gz(r-4.6-any)
ckanr_0.9.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
ckanr/json (API)
| # Install 'ckanr' in R: |
| install.packages('ckanr', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/ropensci/ckanr/issues
Pkgdown/docs site:https://docs.ropensci.org
databaseopen-datackanapidatadatasetapi-wrapperckan-api
Last updated from:468ba8864a (on main). Checks:10 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 174 | ||
| pkgdown docs | OK | 179 | ||
| source / vignettes | OK | 232 | ||
| linux-release | OK | 139 | ||
| macos-release | OK | 107 | ||
| macos-oldrel | OK | 144 | ||
| windows-devel | OK | 104 | ||
| windows-release | OK | 102 | ||
| windows-oldrel | OK | 100 | ||
| wasm-release | OK | 95 |
Exports:activity_createactivity_data_showactivity_deleteactivity_delete_allactivity_delete_countsactivity_diffactivity_showam_following_userapi_token_createapi_token_listapi_token_revokeas.ckan_fileas.ckan_groupas.ckan_organizationas.ckan_packageas.ckan_relatedas.ckan_resourceas.ckan_resource_viewas.ckan_tagas.ckan_useras.ckan_vocabularybulk_update_deletebulk_update_privatebulk_update_publicchangesckan_actionckan_fetchckan_infockan_versionckanr_settingsckanr_setupconfig_option_listconfig_option_showconfig_option_updatedashboard_activity_listdashboard_countdashboard_mark_activities_olddashboard_new_activities_countdataset_am_followingdataset_followdataset_followee_countdataset_followee_listdataset_follower_countdataset_follower_listdataset_purgedataset_unfollowds_createds_create_datasetds_deleteds_function_createds_function_deleteds_infods_records_deleteds_run_triggersds_searchds_search_sqlds_upsertfile_createfile_deletefile_owner_scanfile_ownership_transferfile_pinfile_registerfile_renamefile_showfile_unpinfollow_userfollowee_countfollowee_listformat_autocompleteget_default_keyget_default_urlget_site_userget_test_behaviourget_test_didget_test_gidget_test_keyget_test_oidget_test_ridget_test_urlgroup_activity_listgroup_am_followinggroup_autocompletegroup_creategroup_deletegroup_followgroup_followee_countgroup_followee_listgroup_follower_countgroup_follower_listgroup_listgroup_list_authzgroup_member_creategroup_member_deletegroup_package_showgroup_patchgroup_purgegroup_showgroup_unfollowgroup_updatehelp_showis.ckan_fileis.ckan_groupis.ckan_organizationis.ckan_packageis.ckan_relatedis.ckan_resourceis.ckan_resource_viewis.ckan_tagis.ckan_useris.ckan_vocabularyjob_canceljob_clearjob_listjob_showlicense_listmember_createmember_deletemember_listmember_roles_listorganization_activity_listorganization_autocompleteorganization_createorganization_deleteorganization_followee_countorganization_followee_listorganization_follower_countorganization_follower_listorganization_listorganization_list_for_userorganization_member_createorganization_member_deleteorganization_patchorganization_purgeorganization_showorganization_updatepackage_activity_listpackage_autocompletepackage_collaborator_createpackage_collaborator_deletepackage_collaborator_listpackage_collaborator_list_for_userpackage_createpackage_create_default_resource_viewspackage_deletepackage_listpackage_list_currentpackage_owner_org_updatepackage_patchpackage_relationship_createpackage_relationship_deletepackage_relationship_updatepackage_relationships_listpackage_resource_reorderpackage_revisepackage_revision_listpackage_searchpackage_showpackage_updatepingrecently_changed_packages_activity_listrelated_createrelated_deleterelated_listrelated_showresource_createresource_create_default_resource_viewsresource_deleteresource_patchresource_searchresource_showresource_updateresource_view_clearresource_view_createresource_view_deleteresource_view_listresource_view_reorderresource_view_showresource_view_updaterevision_listsend_email_notificationsserverssrc_ckanstatus_showtag_autocompletetag_createtag_deletetag_listtag_searchtag_showtask_status_deletetask_status_showtask_status_updatetask_status_update_manyterm_translation_showterm_translation_updateterm_translation_update_manyunfollow_useruser_activity_listuser_autocompleteuser_createuser_deleteuser_followee_countuser_followee_listuser_follower_countuser_follower_listuser_inviteuser_listuser_patchuser_showuser_updatevocabulary_createvocabulary_deletevocabulary_listvocabulary_showvocabulary_update
Dependencies:blobclicpp11crulcurlDBIdbplyrdplyrgenericsgluehttpcodejsonlitelifecyclemagrittrmimepillarpkgconfigpurrrR6Rcpprlangstringistringrtibbletidyrtidyselecttriebeardurltoolsutf8vctrswithr
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| R client for the CKAN API | ckanr-package ckanr |
| Activity stream helpers | activity_create activity_data_show activity_diff activity_helpers activity_show dashboard_mark_activities_old dashboard_new_activities_count group_activity_list organization_activity_list recently_changed_packages_activity_list send_email_notifications |
| Activity purge helpers (CKAN 2.12+) | activity_delete activity_delete_all activity_delete_counts activity_purge |
| API token helpers | api_tokens api_token_create api_token_list api_token_revoke |
| ckan_file class helpers | as.ckan_file is.ckan_file |
| ckan_group class helpers | as.ckan_group is.ckan_group |
| ckan_organization class helpers | as.ckan_organization is.ckan_organization |
| ckan_package class helpers | as.ckan_package is.ckan_package |
| ckan_related class helpers | as.ckan_related is.ckan_related |
| ckan_resource class helpers | as.ckan_resource is.ckan_resource |
| ckan_resource_view class helpers | as.ckan_resource_view is.ckan_resource_view |
| ckan_tag class helpers | as.ckan_tag is.ckan_tag |
| ckan_user class helpers | as.ckan_user is.ckan_user |
| ckan_vocabulary class helpers | as.ckan_vocabulary is.ckan_vocabulary |
| Bulk update dataset visibility. | bulk_update bulk_update_delete bulk_update_private bulk_update_public |
| Get an activity stream of recently changed datasets on a site. | changes |
| Generic action function | ckan_action |
| ckanr S3 classes | ckan_classes |
| Download a file | ckan_fetch |
| Get information on a CKAN server | ckan_info ckan_version |
| Get or set ckanr CKAN settings | ckanr_settings get_default_key get_default_url get_test_behaviour get_test_did get_test_gid get_test_key get_test_oid get_test_rid get_test_url |
| Configure default CKAN settings | ckanr_setup |
| Deprecated functions in 'ckanr' | ckanr-deprecated |
| Runtime configuration helpers | config_options config_option_list config_option_show config_option_update |
| Authorized user's dashboard activity stream | dashboard_activity_list |
| Number of new activities of an authorized user | dashboard_count |
| Permanently purge a dataset | dataset_purge |
| Datastore write helpers (CKAN 2.12+ parameters from the start) | datastore_extra ds_delete ds_function_create ds_function_delete ds_info ds_records_delete ds_run_triggers ds_upsert |
| Diagnostics helpers | diagnostics help_show status_show |
| Add a new table to a datastore | ds_create |
| Datastore - create a new resource on an existing dataset | ds_create_dataset |
| Datastore - search or get a dataset from CKAN datastore | ds_search |
| Datastore - search or get a dataset from CKAN datastore | ds_search_sql |
| File management | files file_create file_delete file_ownership_transfer file_owner_scan file_pin file_register file_rename file_show file_unpin |
| Follow and unfollow CKAN datasets or groups | dataset_am_following dataset_follow dataset_unfollow follow_objects group_am_following group_follow group_unfollow |
| Follow or unfollow users | am_following_user follow_user follow_users unfollow_user |
| Followee counts for CKAN users | dataset_followee_count followee_count followee_counts group_followee_count organization_followee_count user_followee_count |
| Followee lists for CKAN users | dataset_followee_list followee_list followee_lists group_followee_list organization_followee_list user_followee_list |
| Follower counts for CKAN objects | dataset_follower_count follower_counts group_follower_count organization_follower_count user_follower_count |
| Follower lists for CKAN objects | dataset_follower_list follower_lists group_follower_list organization_follower_list user_follower_list |
| Autocomplete resource formats. | format_autocomplete |
| Show the CKAN site user. | get_site_user |
| Autocomplete group names. | group_autocomplete |
| Create a group | group_create |
| Delete a group | group_delete |
| List groups. | group_list |
| List groups the current user can edit | group_list_authz |
| Make a user a member of a group | group_member_create |
| Remove a user from a group | group_member_delete |
| Show the datasets of a group. | group_package_show |
| Update a group's metadata | group_patch |
| Purge a group | group_purge |
| Show a group | group_show |
| Update a group | group_update |
| Background job helpers | job_cancel job_clear job_list job_queue job_show |
| Return the list of licenses available for datasets on the site. | license_list |
| Create or update a membership via member_* endpoints | member_create |
| Remove a membership via member_* endpoints | member_delete |
| List members for a group or organization | member_list |
| Report available member roles | member_roles_list |
| Membership helpers | membership |
| Autocomplete organization names. | organization_autocomplete |
| Create an organization | organization_create |
| Delete an organization | organization_delete |
| List organizations | organization_list |
| List organizations a user can act on | organization_list_for_user |
| Make a user a member of an organization | organization_member_create |
| Remove a user from an organization | organization_member_delete |
| Patch an organization. | organization_patch |
| Purge an organization | organization_purge |
| Show an organization | organization_show |
| Update an organization. | organization_update |
| Return a list of the package's activity | package_activity_list |
| Autocomplete dataset names. | package_autocomplete |
| Create or update a dataset collaborator | package_collaborator_create |
| Delete a dataset collaborator | package_collaborator_delete |
| List collaborators for a dataset | package_collaborator_list |
| List packages a user collaborates on | package_collaborator_list_for_user |
| Package collaborator utilities | package_collaborators |
| Create a package | package_create |
| Create default views for all resources in a dataset | package_create_default_resource_views |
| Dataset maintenance helpers | package_dataset_extras |
| Delete a package | package_delete |
| List datasets. | package_list |
| List current packages with resources. | package_list_current |
| Move a dataset to another organization | package_owner_org_update |
| Update a package's metadata | package_patch |
| Create a dataset relationship | package_relationship_create |
| Delete a dataset relationship | package_relationship_delete |
| Update an existing dataset relationship | package_relationship_update |
| Package relationship helpers | package_relationships |
| List relationships for a dataset | package_relationships_list |
| Reorder resources for a dataset | package_resource_reorder |
| Revise a dataset using match/filter/update semantics | package_revise |
| Return a dataset (package's) revisions as a list of dictionaries. | package_revision_list |
| Search for packages. | package_search |
| Show a package. | package_show |
| Update a package | package_update |
| Ping a CKAN server to test if it is up or down. | ping |
| Create a related item | related_create |
| Delete a related item. | related_delete |
| List related items | related_list |
| Show a related item | related_show |
| Create a resource | resource_create |
| Create default views for a single resource | resource_create_default_resource_views |
| Delete a resource. | resource_delete |
| Update a resource's metadata | resource_patch |
| Search for resources. | resource_search |
| Show a resource. | resource_show |
| Update a resource | resource_update |
| Clear resource views | resource_view_clear |
| Create a resource view | resource_view_create |
| Delete a resource view | resource_view_delete |
| List resource views for a resource | resource_view_list |
| Reorder resource views | resource_view_reorder |
| Show a resource view | resource_view_show |
| Update an existing resource view | resource_view_update |
| Resource view management | resource_views |
| Return a list of the IDs of the site's revisions. | revision_list |
| CKAN server URLs and other info | servers |
| Connect to CKAN with dplyr | dplyr-interface src_ckan |
| Autocomplete tag names. | tag_autocomplete |
| Create a tag | tag_create |
| Delete a tag. | tag_delete |
| List tags. | tag_list |
| Search tags. | tag_search |
| Show a tag. | tag_show |
| CKAN task status maintenance | task_status task_status_delete task_status_show task_status_update task_status_update_many |
| Term translation helpers | term_translation term_translation_show term_translation_update term_translation_update_many |
| Return a list of a user's activities | user_activity_list |
| Autocomplete user names. | user_autocomplete |
| Create a user. | user_create |
| Delete a user. | user_delete |
| Invite a user to a group | user_invite |
| Return a list of the site's user accounts. | user_list |
| Patch a user account. | user_patch |
| Show a user. | user_show |
| Update a user account. | user_update |
| Manage CKAN vocabularies. | vocabulary vocabulary_create vocabulary_delete vocabulary_list vocabulary_show vocabulary_update |