Conversation
Contributor
philbosch
commented
Sep 26, 2025
philbosch
commented
- introduce newest version of code to dev branch
* ajdust to new naming convention * extract validator functions * create file for properties * added code loadind order -> Collate in DESCRIPTION * added basic distribution class and create methode * splitted api call in multiple functions: general helper for all API calls, post-specific helper function * feat: initialise text_arguments_parser * feat: implement data set get-functions * feat: implement get-functions for distributions and update all other get-functions * feat: adjust get_organsations name * feat: add specific cli messages depending on distribution or dataset creation * docu: add speaking title to default argument for status_id "Entwurf" * fix: remove browser statement * feat: add update functioanilty to collate/Namespace * feat: add example for update functionality * feat: add helper function to get_daset (needed to extract org_id) --> could be merged with other get_functions later * feat: add user facing update_dataset function * feat: add internal methods for updating dataset and already boiler plate for updating distributions * removed unused attribute "identifier" * improved id validator: 0 is also accepted * add user facing update_distribution function * add example in playground for update_distribution * add properties for posixce, string, numeric, list and logical (validators are later one moved to the validators file) * extract properties * extract args from function call, so that empty args are really empty and thus the defaults from the class are set * fix: address feedback issue #4 * Update README.md * Update README.md * Update README.md * feat: create vignette * feat: make return-object 'invisible' * fix: convert input-ids to lists * Update README.md * feat: treat input-ids as.list() * update vignette * udpate * removed "issued" and "modified" in distribution; added "status_id" in create distribution -> via patch after creation * improved error handling for API post & patch operations: added CLI alerts for failed API responses * update Description * add playground.R since not needed in package * update documentation * add tests * construct Dataset with do.call and add a test parameter * construct distribution object with do.call * add constructor and remove field variable for validator since it is automatically printed in the error message * add the own defined properties and add a constructor * update documentation * update documentation * add helper functions for the constructor * add FIXME * add option to set default * moved to validators.R * construct Dataset object with do.call * remove the field param since in the error message, the name of the field is automatically printed; add nw validator * add github actions * add validator for bytesize * add validators where no were defined * added args logic in update_distribution * created "api_request_wrapper" for unified error/success handling * update documentation * Update .github/workflows/R-CMD-check.yaml Co-authored-by: Philipp Bosch <38976565+philbosch@users.noreply.github.com> * address R CMD warnings * resolve R CMD warnings * added file_upload class und methods * added file upload in create_distribution, if file_path is provided * added file upload in update_distribution, if file_path is provided * improved comments and doc * feat: allow id-to-label-request (work in progress) * implement cli-errors * feat: implement convert_label_to_id-function, add label_switch function, update docs and examples * added create and delete for dummy csv file * fix: allowing creations/updates of dataset with single entries where endpoints allow for multiple arguments * feat: add NULL-handling * update * used rlang::`%||%` * created a validator validate_file_exists * feat: add get_datasets()-function * implement character-arguments for keywords, zw_web_catalog_ids, themes, periodicities, statuses and formates + documentation for see_also_ids, organisations and licenses * adjust test to character-arguments for keywords, zh_web_catalog_ids, themes, see_also_ids and periodicity * update * zh_web_catalogs-endpoint adjustment (due to changes in backend) * hotfix: get rid of library call to "%||%" with rlang import/export * docu: auto-generate documentation * feat: add /document workflow to github actions * feat: add curl as a dependency * fix: add docu name to create_file_upload method (silences warning in devtools::document()) * fix: remove arguments issued & modified from functions * fix: remove library call & adapt date validation * fix: change posixct property to simple date string property * fix: remove issued argument from function * feat: validator for simple date string * docu: auto-generated roxygen docu * fix: adapt tests to reflect changes in backend to issued & modified * feat: adding verbosity argument to user facing functions and all following functions downstrean * feat: remove list flattening (not necessary anymore) & add verbosity arguments * docu: auto generate roxygen docu * fix: change test argument to preview as this is semantically correct * fix: add param preview to function to silence warning * fix: add dummy apy key to test to solve crashing github actions tests * fix: see what github actions uses for S7 * fix: adapt dataset object to reflect changes in S7 0.2. --> sensible defaults * fix: adapt distribution object to reflect changes in S7 0.2. --> sensible defaults * fix: delete testthat setup (not needed anymore due to version bump in S7) * fix: pin httr2 version to 1.1.2 to omit curl version problems * chore: remove internal conversion functinos from exported NAMESPACE * feat: add API_KEY to Github Action Workflow (Key can only read) * fix: adapt create_dataset to run withouth errors (includes type conversions) * fix: adapt dataset object properties * fix: adapt api_request function + object to payload function * fix: major refactoring and re-writing of text-to-argument parsing. * docu: auto-generated roxygen docu * feat: adapt tests and include option to run tests on GH-Actions * fix: pin version of httr2 down * fix: loose restriction of package version httr2 * fix: typo in GH Workflow r-cmd * fix: intendation of yaml * feat: add new functions to collate * feat: adapt create dataset to resolve character string transformation of arguments * feat: refactor api helper functions into their own file * feat: adapt create_distribution (delete non-user friendly arguments) + add start / end date arguments * fix: adapt zh_web_datacatalog_ids so it mirrors the backend * feat: delete right, sort_order & media_type_id from object (not used necessary anymore) and fix file_upload_id to numeric property * feat: new generic for setting the status * fix: refactor api helpers into separate function * feat: methods to set status for dataset and distribution * fix: adapt update_dataset to new arguments and new way of building the ds object * fix: adapt update_distribution to mirror new needed arguments * docu: auto-generated roxygen docu * fix: adapt test to mirror new argument name zh_web_datacatlog_ids * fix: solve warning in check with "withr" in SUGGESTS * feat: add possiblity to extract detailed error message from api call * feat: add preview flag to create_distribution (for testing suite) * fix: change api key lookup to help with testing * feat: improve error messages in text_argument_parser * feat: add preview param to update_distribution (for testing) * docu: auto-generated docu * feat: add testing suite for end-2-end user tests (need api key) * fix: delete get_datasets from NAMESPACE because it is confusing with get_dataset (singular) already in place * fix: remove get_datasets from export * docu: auto generated roxygen docu * fix: new tests for properties * feat: whole testing suite for text_argument_parser function * fix: add skip statement to api lookups for Github Action CI * docu: add rmd stuff to buildignore * docu: first version of readme * docu: add screenshots for readme * docu: delete old vignette * docu: add docu stuff to gitignore * hotfix: base urls anpassen * hotfix: base urls in tests anpassen * Update README.md * feat: add modified next to distribution funciton * docu: auto generated roxygen docu * Update README.md * Update README.md * update README.Rmd * update README.Rmd * Update README.md - delete vignette hint * add hex-sticker * docu: add hex-sticker to readme * Delete LICENSE use license.md * docu: delete vignette hint * docu: delete file LICENSE * fix: adapt base url to new scheme * fix: delete playgroun file for release * docu: version bump to test-version & authors --------- Co-authored-by: tknecht <thomas.knecht@statistik.ji.zh.ch> Co-authored-by: Tabea Eggler <tabea.eggler@hotmail.com> Co-authored-by: Christoph Zust <christoph.zust@statistik.ji.zh.ch> Co-authored-by: Tabea <35971471+tabeaeggler@users.noreply.github.com> Co-authored-by: c-zust <91314187+c-zust@users.noreply.github.com> Co-authored-by: ThomasKnecht <t.knecht@hotmail.com>
docu: fix example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.