Automated scholarly manuscripts on GitHub

Project Description

With the rapidly evolving global situation related to COVID-19, the infectious disease caused by the SARS-CoV-2 virus, there is a need to centralize scientific knowledge relevant to the development of diagnostics and therapeutics. This repository is an online, collaborative review paper written with manubot. We are seeking input from scientists at all levels anywhere in the world.

Our goal is to quickly and accurately summarize and synthesize the papers that are coming out in order to develop a broader picture of what's being attempted and the status of those efforts. We hope to contextualize elements of this virus and infectuous disease with respect to better understood viruses and diseases (e.g., to identify shared mechanisms). This repository is also a living document that aims to consolidate and integrate helpful information about diagnostics and therapeutics that is circulating in dectralizaed spaces (e.g., Twitter threads) into a more permanent and unified format.

Contributions

At present, there are three ways to contribute:

If you know of information, especially a peer-reviewed or pre-print article, that you want to see incorporated, please create an issue to let us know about it.
If you have experience reading scientific literature, you can propose additions to the text through pull requests, and pull requests that address an open issue are particularly appreciated.
Let others know about this effort so that they can contribute!

Please note that non-scientists are more than welcome to contribute by opening issues to let us know about topics they'd like to see addressed or included.

Pull Requests

To open a pull request, please:

Fork the repository greenelab/covid19-review
Add your changes (you may want to do so on a branch specific to the topic you're addressing). If writing full paragraphs, please put one sentence per line.
Submit a pull request too add your changes to greenelab/covid19-review
Submit a second pull request to add your information to the bottom of greenelab/covid19-review/content/metadata.yaml using the format outlined here

For an introduction to using git, see this open-source lesson from Software Carpentry. If you are a virologist, medical professional, or expert in another non-computational field who wants to contribute but feels concerned about contributing through git, please open an issue or reach out to Halie Rando.

Manubot

Manubot is a system for writing scholarly manuscripts via GitHub. Manubot automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub. An overview manuscript presents the benefits of collaborative writing with Manubot and its unique features. The rootstock repository is a general purpose template for creating new Manubot instances, as detailed in SETUP.md. See USAGE.md for documentation how to write a manuscript.

Please open an issue for questions related to Manubot usage, bug reports, or general inquiries.

Repository directories & files

The directories are as follows:

content contains the manuscript source, which includes markdown files as well as inputs for citations and references. See USAGE.md for more information.
output contains the outputs (generated files) from Manubot including the resulting manuscripts. You should not edit these files manually, because they will get overwritten.
webpage is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
build contains commands and tools for building the manuscript.
ci contains files necessary for deployment via continuous integration.

Local execution

The easiest way to run Manubot is to use continuous integration to rebuild the manuscript when the content changes. If you want to build a Manubot manuscript locally, install the conda environment as described in build. Then, you can build the manuscript on POSIX systems by running the following commands from this root directory.

# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot

# Build the manuscript, saving outputs to the output directory
bash build/build.sh

# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.

# Configure the webpage directory
manubot webpage

# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server

Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected. The following command, while running, will trigger both the build.sh script and manubot webpage command upon content changes:

bash build/autobuild.sh

Continuous Integration

Whenever a pull request is opened, CI (continuous integration) will test whether the changes break the build process to generate a formatted manuscript. The build process aims to detect common errors, such as invalid citations. If your pull request build fails, see the CI logs for the cause of failure and revise your pull request accordingly.

When a commit to the master branch occurs (for example, when a pull request is merged), CI builds the manuscript and writes the results to the gh-pages and output branches. The gh-pages branch uses GitHub Pages to host the following URLs:

HTML manuscript at https://manubot.github.io/rootstock/
PDF manuscript at https://manubot.github.io/rootstock/manuscript.pdf

For continuous integration configuration details, see .github/workflows/manubot.yaml if using GitHub Actions or .travis.yml if using Travis CI.

License

Except when noted otherwise, the entirety of this repository is licensed under a CC BY 4.0 License (LICENSE.md), which allows reuse with attribution. Please attribute by linking to https://github.com/manubot/rootstock.

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). 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 for any question related to licensing.

agitter / covid19-review