https://github.com/zietzm/vagelos2017
A report on the work done during Summer 2017 in the Greene Lab
https://github.com/zietzm/vagelos2017
Last synced: 3 months ago
JSON representation
A report on the work done during Summer 2017 in the Greene Lab
- Host: GitHub
- URL: https://github.com/zietzm/vagelos2017
- Owner: zietzm
- License: other
- Created: 2017-08-14T18:49:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-31T20:44:15.000Z (over 6 years ago)
- Last Synced: 2025-01-13T01:34:38.790Z (4 months ago)
- Language: CSS
- Homepage: https://zietzm.github.io/Vagelos2017/
- Size: 7.47 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-CC0.md
Awesome Lists containing this project
README
## Summer Report for the Vagelos Scholars Program in Molecular Life Science
Report detailing work done in the Greene Lab at the University of Pennsylvania for the Summer of 2017.
Sparse matrix implementation of degree-weighted path count (DWPC) over a heterogeneous network of biomedical information.
Summer research conducted as part of the Penn Vagelos Scholars Program in Molecular Life Science (MLS).
https://doi.org/10.6084/m9.figshare.5346577
# Continuous manuscripts written collaboratively on GitHub
[Manubot Rootstock](https://git.io/vQSvo) provides a system for collaboratively writing scholarly manuscripts via GitHub.
This project aims to automate publishing.
For example, citation and referencing are largely automated.
This project originated with the [Deep Review](https://github.com/zietzm/deep-review), but was moved here in hopes of making a general purpose template for the system.
A rootstock (or rhizome) is "a plant onto which another variety is grafted".
This repository plays the role of a botanical trunk.
Fork it and a manuscript will grow.
The most current version of the `master` branch is built by continuous integration and [available via gh-pages](https://zietzm.github.io/Vagelos2017/).
To see what's incoming, check the [open pull requests](https://github.com/zietzm/Vagelos2017/pulls).
Instructions for using Manubot Rootstock for your own manuscript are still evolving.
The recommended approach is to clone this repository, as detailed [here](https://github.com/zietzm/Vagelos2017/issues/6#issuecomment-314541837).
## Repository directories & files
See [`USAGE.md`](USAGE.md) for documentation on how to create or contribute to a manuscript.
The directories are as follows:
+ [`content`](content) contains the manuscript source, which includes markdown files as well as inputs for citations and references.
+ [`output`](output) contains the outputs (generated files) from the manubot including the resulting manuscripts.
You should not edit these files manually, because they will get overwritten.
+ [`webpage`](webpage) is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
+ [`build`](build) contains commands and tools for building the manuscript.
+ [`ci`](ci) contains files necessary for deployment via continuous integration.
For the CI configuration, see [`.travis.yml`](.travis.yml).
## Local execution
To run the Manubot locally, install the [conda](https://conda.io) environment as described in [`build`](build).
Then, you can build the manuscript on POSIX systems by running the following commands.
```sh
# Activate the manubot conda environment
source activate manubot
# Build the manuscript
sh build/build.sh
# View the manuscript locally at http://localhost:8000/
cd webpage
python -m http.server
```
## Continuous Integration
[](https://travis-ci.org/zietzm/Vagelos2017)
When you make a pull request, Travis CI will test whether your changes break the build process to generate the formatted manuscript.
The build process aims to detect common errors, such as invalid references.
If your build fails, see the Travis CI logs for the cause of failure and revise your pull request accordingly.
When a pull request is merged, Travis CI performs the build and writes the results to the [`gh-pages`](https://github.com/zietzm/Vagelos2017/tree/gh-pages) and [`output`](https://github.com/zietzm/Vagelos2017/tree/output) branches.
The `gh-pages` branch hosts the following URLs:
+ **HTML manuscript** at https://zietzm.github.io/Vagelos2017/
+ **PDF manuscript** at https://zietzm.github.io/Vagelos2017/manuscript.pdf
For continuous integration configuration details, see [`.travis.yml`](.travis.yml).
## License
[](http://creativecommons.org/licenses/by/4.0/)
[](https://creativecommons.org/publicdomain/zero/1.0/)
This entirety of this repository is licensed under a CC BY 4.0 License ([`LICENSE.md`](LICENSE.md)), which allows reuse with attribution.
Please attribute by linking to https://github.com/zietzm/Vagelos2017.
Since CC BY is not ideal for code and data, certain repository components are also released under the CC0 1.0 public domain dedication ([`LICENSE-CC0.md`](LICENSE-CC0.md)).
All files matched by the following glob patterns are dual licensed under CC BY 4.0 and CC0 1.0:
+ `*.sh`
+ `*.py`
+ `*.yml` / `*.yaml`
+ `*.json`
+ `*.bib`
+ `*.tsv`
+ `.gitignore`
All other files are only available under CC BY 4.0, including:
+ `*.md`
+ `*.html`
+ `*.pdf`
+ `*.docx`
Please open [an issue](https://github.com/zietzm/Vagelos2017/issues) for any question related to licensing.