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

Review file structure #1

Closed
amyjsdavis opened this issue Sep 2, 2019 · 6 comments
Closed

Review file structure #1

amyjsdavis opened this issue Sep 2, 2019 · 6 comments
Assignees

Comments

@amyjsdavis
Copy link
Contributor

No description provided.

@damianooldoni
Copy link
Contributor

damianooldoni commented Sep 19, 2019

  1. It's a little difficult to review structure with not so many files actually. However, it is quite ok as it comes from the Cookie Cutter project 👍
  2. I see that you are using Python! Nice. And good to know too. This will make impossible to put your future functions in trias R package. But I understand that Python is a very powerful programming language, and for computationally demanding steps way faster than R. So, no issues on it if you need Python's speed 👍
  3. I see that there is a standard R .gitignore file. If you use Python, maybe you can update it to something like this: [python gitignore] or a part of it.(https://github.com/github/gitignore/blob/master/Python.gitignore).
  4. The only code I see up to now refers to raw data processing. But there is no raw data still. Are they too big to be put here? Moreover, if you use data coming from other TriAS repositories, please do not copy paste them, just read them via something like this, but maybe you know it already?
import urllib
raw_data = urllib.urlopen(target_url).read()

@amyjsdavis
Copy link
Contributor Author

amyjsdavis commented Sep 19, 2019

I plan on only using R code for the TrIAS modelling. I just used python to set up the file structure using cookie cutter. Indeed raw data is too big.

@damianooldoni
Copy link
Contributor

As said before, it is difficult at this stage to make a in-depth review. Still, I suppose we would like to have some pipelines in order to follow the workflow. For us and for others as well. So, maybe adding notebooks subdirectory as suggested by cookiecutter?

If you have other solutions in mind, you are very welcome to share them!

@damianooldoni
Copy link
Contributor

Forget notebooks directory if you are not using Python then.
Typically, we make Rmd files in src and put functions in trias package.
At this stage of work, you can put R file with functions in src as well, and then I will move them to TrIAS package and I will apply the needed changes to the pipelines (aka Rmd files).

@damianooldoni
Copy link
Contributor

I just used python to set up the file structure using cookie cutter.
The file structure can be set up without using Python files.

FYI, from a stackoverflow post:

Git cannot add a completely empty directory. People who want to track empty directories in Git have created the convention of putting files called .gitkeep in these directories. The file could be called anything; Git assigns no special significance to this name.

Files starting with a point are hidden files so, they don't bother you too much. Still, if you plan to add files very soon, forget this approach and leave everything as it is now. You can remove the Python files meanwhile you add R files.

@damianooldoni
Copy link
Contributor

I think this issue can be closed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants