scitree
Scitree is a recursive directory listing tool optimized for science
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Keywords
Repository
Scitree is a recursive directory listing tool optimized for science
Basic Info
Statistics
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 3
- Releases: 3
Topics
Metadata Files
README.md
Scitree - Like tree, but optimized for science
In computing, tree is a recursive directory listing command or program that produces a depth-indented listing of files. Wikipedia, 2022.
Scitree is like tree, but different. Instead of sorting content on its name, scitree sorts and highlights given opiniated scientific principles. In this way, you can inspect directory listings more easily.
Scitree is based on scisort, a Python package to sort file paths based on scientific principles.
Philosophy
Philosophy of scisort and scitree:
- Read the README first, therefore I'm on top
- Before I install or use the content, I open the LICENSE.
- Files first, folders second
- Numbered files are naturally sorted
- I love intuitive and reproducible project structures
- Follow the order of execution where possible
- I ignore, what git ignores*
* Only for scitree.
For more information about the structure, see scisort/scisort/keygen.py.
Installation
Scitree requires Python 3.6 or later.
sh
pip install scitree
Getting started
scitree command
Scittree command on the command line outputs a tree.
sh
scitree
```sh ./ ├── README.md ├── LICENSE.txt ├── jobs.sh ├── data/ │ └── Bos2018.csv ├── scripts/ │ ├── getplot.py │ ├── mergedescriptives.py │ └── mergemetrics.py └── output/ ├── simulation/ │ └── Bos2018/ │ ├── metricssimBos20180.json │ ├── metricssimBos20186.json │ ├── metricssimBos2018559.json │ ├── metricssimBos20181640.json │ ├── metricssimBos20183154.json │ ├── metricssimBos20183518.json │ ├── metricssimBos20183519.json │ ├── metricssimBos20183721.json │ ├── metricssimBos20184612.json │ ├── metricssimBos20184699.json │ ├── metricssimBos20185673.json │ ├── plotrecallsimBos2018.png │ ├── descriptives/ │ │ ├── wordcloudBos2018.png │ │ ├── wordcloudirrelevantBos2018.png │ │ ├── wordcloudrelevantBos2018.png │ │ └── datastatsBos2018.json │ └── statefiles/ │ ├── simBos20180.asreview │ ├── simBos20186.asreview │ ├── simBos2018559.asreview │ ├── simBos20181640.asreview │ ├── simBos20183154.asreview │ ├── simBos20183518.asreview │ ├── simBos20183519.asreview │ ├── simBos20183721.asreview │ ├── simBos20184612.asreview │ ├── simBos20184699.asreview │ └── simBos20185673.asreview └── tables/ ├── datadescriptives.csv ├── datadescriptives.xlsx ├── datametrics.csv └── datametrics.xlsx
8 directories, 38 files ```
scitree function for Python
The scitree function in Python prints the tree for the current folder (".").
```python from scitree import scitree
scitree() ```
License
Contact
Feel free to reach out with questions, remarks, and suggestions. The issue tracker is a good starting point. You can also email me at jonathandebruinos@gmail.com.
Owner
- Name: Jonathan de Bruin
- Login: J535D165
- Kind: user
- Location: Netherlands
- Company: Utrecht University
- Repositories: 45
- Profile: https://github.com/J535D165
Research engineer working on software, datasets, and tools to advance open science 👐 @UtrechtUniversity @asreview
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "De Bruin" given-names: "Jonathan" orcid: "https://orcid.org/0000-0002-4297-0502" title: "Scitree - Like tree, but optimized for science" url: "https://github.com/J535D165/scitree" repository-code: "https://github.com/J535D165/scitree"
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers
Last synced: almost 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jonathan de Bruin | j****s@g****m | 33 |
| Jelle Teijema | j****a@g****m | 1 |
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 5
- Total pull requests: 3
- Average time to close issues: about 1 month
- Average time to close pull requests: 10 days
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 2.4
- Average comments per pull request: 1.33
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 1.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- vankesteren (3)
- jteijema (2)
Pull Request Authors
- jteijema (2)
- J535D165 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 10,455 last-month
- Total docker downloads: 47
- Total dependent packages: 1
- Total dependent repositories: 1
- Total versions: 3
- Total maintainers: 1
pypi.org: scitree
One downloader for many scientific data and code repositories!
- Documentation: https://scitree.readthedocs.io/
- License: MIT
-
Latest release: 0.5.3
published almost 3 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v1 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pypa/gh-action-pypi-publish release/v1 composite
- gitignorefile *
- natsort *
- scisort *
- seedir *