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

Roadmap #1

Closed
11 tasks done
drizk1 opened this issue Mar 23, 2024 · 11 comments
Closed
11 tasks done

Roadmap #1

drizk1 opened this issue Mar 23, 2024 · 11 comments

Comments

@drizk1
Copy link
Member

drizk1 commented Mar 23, 2024

  • Read/write csv
  • Read/write tsv
  • Read/write table
  • Read/write delim
  • Read/write excel
  • Read fwf
  • refine fwf helper functions to include name
  • stats support
  • Add https support?
  • Docs - files are added it just needs to build
  • Docstrings
@drizk1
Copy link
Member Author

drizk1 commented Mar 23, 2024

hey @kdpsingh I cranked thru a good amount of the file types. before i get started working on docs/docstrings, i was wondering if u wanted them to have https get support for online data(readr does for csv/tsv/delim). i have one for csv and it would be p easy to do, but i thought id get your take first as it would add one more dependency to the package. happy either way. Also lmk if ive missed any key types to get up and running for the v.1

@kdpsingh
Copy link
Member

Adding a dependency is fine if it means we can read in files from the web in all of the above formats.

@kdpsingh
Copy link
Member

Would also love to add support for all formats supported in the haven R package (eg SAS and Stata files)

@drizk1
Copy link
Member Author

drizk1 commented Mar 24, 2024

adding support for SAS and Stata files is no problem. The ReadStatTables.jl package made it ridiculously easy. so i already have support for all of them. The package made it so the underlying function is identical ReadStatTables.read_stat and ReadStatTables.writestat for all 3, and all i do is change the name for sas/sav/dta. So if its the same function for each, should each have its own _sas, _sav, _dta or should it be a generic read_stat/write_stat? (theres no difference on labor for me)

@kdpsingh
Copy link
Member

Great question! Let me think about this.

@kdpsingh
Copy link
Member

kdpsingh commented Mar 24, 2024

Here's my idea:

Let's make specific function names to match the extension (read_sas, etc).

At some later point, we may also add a single read_file() and write_file() function that infers the correct extension and calls the correct function specific to that extension.

@drizk1
Copy link
Member Author

drizk1 commented Mar 25, 2024

sounds good. this repo might be nearly ready! Just need to pkg template it and make sure docstrings run

@drizk1
Copy link
Member Author

drizk1 commented Mar 25, 2024

I know its Monday and as a gainfully employed person, I assume you are busy but a quick update:

Doctests clock in locally at 39.7s. I pared that down from 50, but I was unable to drop it further. Open to suggestions.

Files are in place for documentation, with a brief index.md written.

The only thing, when i was going thru the pkgtemplate.jl prompts I must have missed setting up the github tests? so theyre not running online. I am not sure how to enable that.

Otherwise, I think this should be ready for transfer to TidierOrg / head to registry

Doctests: TidierFiles |    1      1  39.7s

@kdpsingh
Copy link
Member

Amazing. I can help figure out the GitHub tests (need to set up GitHub actions).

Don't worry about the test completion time. 40 seconds is totally fine.

Can you move this repo over to TidierOrg?

@drizk1
Copy link
Member Author

drizk1 commented Mar 26, 2024

That would be awesome thank you!

Just transferred it

@drizk1
Copy link
Member Author

drizk1 commented Apr 12, 2024

11/11 on checklist. I'll go ahead and close this.

@drizk1 drizk1 closed this as completed Apr 12, 2024
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

2 participants