Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 6.74 KB

README.md

File metadata and controls

130 lines (93 loc) · 6.74 KB
Raw

HTML Manuscript PDF Manuscript Build Status bioRxiv preprint

VG-SV manuscript

This is the repo for the manuscript on SV genotyping using vg. The code to reproduce the analysis is available at https://github.com/vgteam/sv-genotyping-paper. Preprint versions are available on bioRxiv. It was published in Genome Biology on Feb 12 2020.

Quick "how to use":

  • Write content in the Markdown files in the content folder.
  • Write one-sentence per line (to get cleaner git diffs).
  • E.g. citation: [@doi:10.1038/nmeth.4366] or [@tag:vgnbt] in with tag defined in content/citation-tags.tsv. If it's a preprint from bioRxiv or it has a consortium name as an author it's safer to use [@url:https://doi.org/10.1038/ng.3834].
  • Update title/author infos in content/metadata.yaml.
  • More in USAGE.md.
  • In-text comments using: <!-- This is a comment --> or [//]: # (This is a comment).
  • Travis is setup to build HTML/PDF (see buttons above). Or build locally.
  • A few more utilities in the Makefile.

Manubot documentation: automated scholarly manuscripts on GitHub

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 the 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. For the CI configuration, see .travis.yml.

Local execution

To run the Manubot locally, install the conda environment as described in build. Then, you can build the manuscript on POSIX systems by running the following commands.

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

# Build the manuscript, saving outputs to the output directory
sh 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.

# Configure the webpage directory
python build/webpage.py

# View the manuscript locally at http://localhost:8000/
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 and webpage.py scripts upon content changes:

sh build/autobuild.sh

Continuous Integration

Build Status

Whenever a pull request is opened, Travis CI 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 Travis 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), Travis 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:

For continuous integration configuration details, see .travis.yml.

License

License: CC BY 4.0 License: CC0 1.0

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/jmonlong/manu-vgsv.

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.