Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add vignettes on algorithm arguments + options; update qgis_run_algorithm() docs #213

Merged
merged 10 commits into from
Jul 2, 2024

Conversation

florisvdh
Copy link
Member

@florisvdh florisvdh commented Jun 26, 2024

Two vignettes are added:

  • an overview of R object classes that are accepted for each QGIS argument type, in tabular format. It is an attempt to summarize the outcomes of Complete input argument type parsing #13.
  • an overview of available options & environment variables to configure package behaviour.

Whoever has some time, please review!

A convenient way to render them locally is by running:

pkgdown::init_site()
pkgdown::build_article("qgis_arguments")
pkgdown::preview_page("articles/qgis_arguments.html")
pkgdown::build_article("qgis_options")
pkgdown::preview_page("articles/qgis_options.html")

This might be included in a next package release before useR! 2024; some features were already added earlier this year.

@florisvdh
Copy link
Member Author

florisvdh commented Jun 26, 2024

  • Still to be added (forgot to do so): qgis_output* classes (ed85db6).

@florisvdh
Copy link
Member Author

florisvdh commented Jun 27, 2024

  • Also add a (shorter) respin of the paragraph 'For data objects in R that already exist as a stored file [...]' from the docs of qgis_run_algorithm().

@florisvdh florisvdh changed the title Vignette: passing R objects as algorithm arguments Add vignettes on algorithm arguments + options; update qgis_run_algorithm() docs Jun 28, 2024
@florisvdh florisvdh merged commit 5fc5416 into main Jul 2, 2024
@florisvdh florisvdh deleted the vign branch July 2, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant