GithubHelp home page GithubHelp logo

archivist.github's People

Contributors

marcinkosinski avatar pbiecek avatar stewid avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

gitter-badger

archivist.github's Issues

Obsolete function name in old vignette

Hi Marcin,

I was going through an old vignette (this one)
image

On the StackOverflow reprex you have posted, you call the function loadFromGithubRepo().

In my version of archivist ( archivist * 2.3.2 2019-01-02 [1] CRAN (R 3.6.0)) the function is renamed to archivist::loadFromRemoteRepo().

After I swapped the function name, your example worked as expected and I retrieved the object.

Thought I'd let you know since I spotted it.
Thanks for this really valuable package.

CRAN UPDATE

Thanks, we see:

Found the following (possibly) invalid URLs:
URL: http://cran.r-project.org/package=archivist.github/
From: README.md
Status: 200
Message: OK
CRAN URL not in canonical form
URL: http://pbiecek.github.io/archivist/Posts.html
From: man/addHooksToPrintGitHub.Rd
man/archive.Rd
man/archivist-github-integration.Rd
man/archivist.github-package.Rd
man/authoriseGitHub.Rd
man/cloneGitHubRepo.Rd
man/createGitHubRepo.Rd
man/deleteGitHubRepo.Rd
man/pushGitHubRepo.Rd
Status: 404
Message: Not Found
URL: https://cran.r-project.org/web/packages/archivist.github/index.html
From: inst/doc/archivist_and_GitHub_integration.html
Status: 200
Message: OK
CRAN URL not in canonical form
URL: https://pbiecek.github.io/archivist/Posts.html
From: inst/doc/archivist_and_GitHub_integration.html
Status: Error
Message: libcurl error code 35:
error:1407742E:SSL routines:SSL23_GET_SERVER_HELLO:tlsv1 alert protocol version
The canonical URL of the CRAN page for a package is
https://CRAN.R-project.org/package=pkgname
Canonical CRAN.R-project.org URLs use https.

Please fix and resubmit.

Best,
Uwe Ligges

More verbose createGitHubRepo()

Right now there are no messages about progress of createGitHubRepo().
If something is going wrong (i.e. R is just waiting...) it is hard to find out what is going on.
Proposition: adding verbose messages about current state

  • creating an empty GitHub Repository
  • initialize local git repository
    so on

examples for callback

Consider adding a screenshot with example for application callback in the section '2.1 OAuth open autorization'
http://marcinkosinski.github.io/archivist.github/#2_working_with_github_repository

Also it may be misleading that 'Client ID; Client Secret' should be copied as 'key/secret' i oauth_app().

You cannot change names of arguments in oauth_app, but maybe you can add a function authorise() to the archivist.github with correct arguments names

authorise(ClientID = , ClientSecret=)

Maybe by adding an screenshot it will make it easier to start with this function because rght now it non trivial.

new function: authoriseGitHub ?

In many examples you have:

' myapp <- oauth_app("github",

' key = app_key,

' secret = app_secret)

' github_token <- oauth2.0_token(oauth_endpoints("github"),

' myapp,

' scope = "public_repo")

' aoptions("github_token", github_token)

Instead of this one could use

authoriseGitHub(app_key, app_secret)

Professional R Code Review

About

archivist.github is a package that allows to archive R objects automatically on GitHub via GitHub API and git2r package. More or less one uses such code to archive his R object on GitHub from R:

createGitHubRepo(repo = "Gallery", default = TRUE) 
iris.lm.model <- lm(Sepal.Length ~ Sepal.Width + Petal.Length + Petal.Width,
                                        data= iris)
archive(iris.lm.model, alink = TRUE)

archivist::aread('MarcinKosinski/Gallery/caab8f8e72045c93f92091aebcb74f2d')

showRemoteRepo(repo = 'Gallery', user = 'MarcinKosinski')[1:3, ]
                           md5hash                             name         createdDate
1 caab8f8e72045c93f92091aebcb74f2d                    iris.lm.model 2016-02-24 19:12:15
2 b0f870835c546853b70f921f57e100b4 b0f870835c546853b70f921f57e100b4 2016-02-24 19:12:15
3 7a761a2ae54f3d90060a9f6ca04b3506 7a761a2ae54f3d90060a9f6ca04b3506 2016-02-24 19:12:15

Professional R Code Review

I am planning to upload ver 0.2 on CRAN so one better download this package from GitHub, so far:

devtools::install_github('MarcinKosinski/archivist.github')

Review

I am developing so many packages that I run out of human resouces, concentration and perspective.
I would appreciate a feedback with user experience feelings. I am wondering whether documentation is complete, examples are well suited, web-site of the package is clear, or are there any functionalities that are missing, and whether the code is easy to proceed with updates for someone not working on this project normally. + Is the OAuth-token-creation well described in man and website?

I would appreciate pull-request with improvements and new issues with user request or bugs detections. For those who will contribute in appropriately enough dedication I'll can guarantee mentioning that person in NEWS.md and, if deserved, in DESCRIPTION

I can repay in writing a linkedin opinion, dinner invitation, proceeding with training with R or handing a bottle of rum (Havana, 3 years old).

createGitHubRepo git2r issue

Hello,
Trying to make a first use of archivist.github,
when I run:

createGitHubRepo(repo="my-repo-name" ,user="myusername" ,password = "psswd" ,github_token = github_token ,repoDescription = "a desc" ,default = TRUE)

I get the following error message:

Error in default_signature(repo) : Error in 'git2r_signature_default': Config value 'user.name' was not found

Any insight ?
Thanks by advance, and thank you for your work.

Below my sessionInfo:

``

sessionInfo()
R version 3.3.2 (2016-10-31)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 7 x64 (build 7601) Service Pack 1

attached base packages:
[1] stats graphics grDevices utils datasets methods base

other attached packages:
[1] git2r_0.18.0 httr_1.2.1 archivist.github_0.2.2 archivist_2.1.2

loaded via a namespace (and not attached):
[1] Rcpp_0.12.9 lubridate_1.6.0 withr_1.0.2 digest_0.6.10 bitops_1.0-6 R6_2.2.0 jsonlite_1.2
[8] DBI_0.5-1 magrittr_1.5 RSQLite_1.1-2 stringi_1.1.2 curl_2.3 rstudioapi_0.6 devtools_1.12.0
[15] tools_3.3.2 stringr_1.1.0 RCurl_1.95-4.8 memoise_1.0.0 openssl_0.9.6 `
``

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.