Based on this lesson, with some more hints and suggestions.
From lesson:
project_name/
├── README.md # overview of the project
├── data/ # data files used in the project
│ ├── README.md # describes where data came from
│ └── sub-folder/ # may contain subdirectories
├── processed_data/ # intermediate files from the analysis
├── manuscript/ # manuscript describing the results
├── results/ # results of the analysis (data, tables, figures)
├── src/ # contains all code in the project
│ ├── LICENSE # license for your code
│ ├── requirements.txt # software requirements and dependencies
│ └── ...
└── doc/ # documentation for your project
├── index.rst
└── ...
Based on this lesson, with some more hints and suggestions.
From lesson:
project_name/ ├── README.md # overview of the project ├── data/ # data files used in the project │ ├── README.md # describes where data came from │ └── sub-folder/ # may contain subdirectories ├── processed_data/ # intermediate files from the analysis ├── manuscript/ # manuscript describing the results ├── results/ # results of the analysis (data, tables, figures) ├── src/ # contains all code in the project │ ├── LICENSE # license for your code │ ├── requirements.txt # software requirements and dependencies │ └── ... └── doc/ # documentation for your project ├── index.rst └── ...
Or suggest to use one of other existing ones eg from here: https://heidiseibold.ck.page/posts/setting-up-a-fair-and-reproducible-project