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

Update usage instructions on showcase page #115

Closed
4 of 7 tasks
anuveyatsu opened this issue Oct 12, 2017 · 4 comments
Closed
4 of 7 tasks

Update usage instructions on showcase page #115

anuveyatsu opened this issue Oct 12, 2017 · 4 comments
Assignees

Comments

@anuveyatsu
Copy link
Collaborator

anuveyatsu commented Oct 12, 2017

Usage instructions from various softwares are now seems not working due to massive changes in the backend. We want to update them so users can still follow those instructions.

Acceptance criteria

  • All instructions on showcase page are upto date and working

Tasks

  • Update R instructions
  • Updates Pandas instructions
  • Update Python instructions
  • Update SQL instructions
    • copy the code from current instruction (from datahu.io showcase page) and update so that it works on your local machine
  • Update JS instructions according to data.js library

Analysis

R/Pandas/Python/SQL:

Check if we're using correct path when reading a datapackage, e.g., for R:

datapackage <- datapkg_read("https://pkgstore.datahub.io/f512ef8d39ada702fde60efe1ca59c17/farm-survey/latest")

and update the dataset path with actual working one.

Javascript:

Options:

  1. Update instrucitons with usage of data.js library instead of datapackage-js
  2. We're using datapackage-js lib of version 0.8.1. We need to update instructions with usage of v1.
@Mikanebu
Copy link
Contributor

Mikanebu commented Oct 18, 2017

There are 2 libraries for R None of them are useful:

Possible solutions:

  • Ask okgreece folks to provide instructions and update our instructions appropriately
  • Read code and understand how it works and provide instructions for ourselves
  • Forget about R and do not display it on showcase page

Ans: For now let's ask for instructions

  • Python example is updated with new version [email protected] and working
  • Panadas is working without modifications
  • Javascript is working fine
  • Sqlite needs refac toring as they use Package.save for similar operation
  • we do not support a PHP

Mikanebu added a commit that referenced this issue Oct 25, 2017
…#121)

* [instructions][xs]: R usage for getting metadata and data - refs #115

* [fixed][xs]: updated path for datapackage.json -refs #115
@anuveyatsu
Copy link
Collaborator Author

UPDATE:

  • SQL instructions are broken
  • we now also have Ruby and PHP instructions:
    • Ruby is tested but PHP is not
    • we need to add them into the site once both are tested

@rufuspollock
Copy link
Contributor

@Mikanebu @anuveyatsu can you guys get this complete - or leave out the SQL instructions for now (and open a special issue just for that).

Mikanebu added a commit that referenced this issue Nov 2, 2017
anuveyatsu pushed a commit that referenced this issue Nov 2, 2017
@anuveyatsu
Copy link
Collaborator Author

FIXED

  • updated R, Python, Pandas, JS instructions
  • we've removed SQL instructions as it is not working atm - Fix and add SQL instructions #124
  • added new instructions re Ruby
  • didn't add PHP instructions as upstream library is out of date

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

No branches or pull requests

4 participants