datamade / data-analysis-guidelines

📒 Analyzing Data, the DataMade Way
MIT License
36 stars 4 forks source link

Be clearer about how pweave works #8

Open hancush opened 6 years ago

hancush commented 6 years ago

To use pweave, first write an input file (Pweave markdown, Pweave LaTeX, etc.) with code enclosed in noweb syntax (that's <<>>= on a new line at the top and @ on a new line at the bottom).

If you're using the interactive Atom environment:

Once you've written your input file, use the command line utility to run the code blocks and incorporate their output into your analysis. All output is included by default. You can change the default to hide all output using rcParams, or disable it on a block-by-block basis using the echo option:

# A disabled code block
<< echo = False >>=
print("You can't see me")
@