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

Overhaul package #45

Open
wants to merge 34 commits into
base: master
Choose a base branch
from
Open

Conversation

salim-b
Copy link
Contributor

@salim-b salim-b commented Oct 13, 2020

  • rewrite majority of R code to be more consistent and logically coherent incl. lots of renamings; use consistent style (mostly tidyverse-compliant; but line width @ 160)

  • improve QSS installation for Windows by checking file access permissions; display a warning with more infos if permissions are insufficient (not admin)

  • improve QSS installation for Linux: ask interactively for administrator credentials by calling Polkit's pkexec and perform all admin-level actions in one go

  • improve/extend documentation; should be less confusing now for users who haven't heard about RStudio's QSS files before

  • improve/extend package title and description

  • update and convert README to R Markdown format (and generate README.md using devtools::build_readme()) to make use of RStudio 1.4's new Markdown canonicalization

  • needs testing on Windows! otherwise package should be more-or-less ready for a CRAN submission at this point (though we might want to tackle other issues first)

- rewrite majority of R code to be more consistent and logically coherent incl. lots of renamings

- improve QSS installation for Windows by checking file access permissions; display a warning with more infos if permissions are insufficient (not admin)

- improve QSS installation for Linux: ask interactively for administrator credentials by calling [Polkit](https://en.wikipedia.org/wiki/Polkit)'s
#' [`pkexec`](https://www.freedesktop.org/software/polkit/docs/latest/pkexec.1.html) and perform all admin-level actions in one go

- improve/extend documentation; should be less confusing now for users who didn't know about QSS
(obsolete leftover)
(wasn't really intentional to use it😅)
this is performed by Pandoc under the hood and only available in RStudio 1.4+, see https://rstudio.github.io/visual-markdown-editing/
and overhaul it to be more clear/precise
(RStudio's built-in auto-formatting broke the proper Markdown syntax 😒)
@salim-b
Copy link
Contributor Author

salim-b commented Nov 16, 2020

@anthonynorth Did you have a chance to look at this PR?

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.

None yet

1 participant