Git Product home page Git Product logo

rlp's Introduction

rlp

This is an example package of using Literate Programming for developing R packages. Most R package authors probably write R code in the R scripts under the R/ directory, and use comments to explain code. This package shows that you do not have to develop a package in this way. You may write R code in R Markdown documents, and extract the code to the R/ directory automatically via knitr::purl(). At the same time, you will get a nicely formatted output document displaying the source code chunks as well as the text/prose chunks, and this output document can be a package vignette. Please see the package homepage for more details: https://yihui.org/rlp/. This package is licensed under MIT, and you are welcome to file issues or submit pull requests.

Acknowledgements

This approach is not possible (at least not easy) without a few important components in the toolchain:

  • The support for non-Sweave vignettes since R 3.0.0, which has opened far more possibilities than I originally imagined;
  • The RStudio IDE, which allows us to build an R package by clicking a button;
  • The rmarkdown package, which generates beautiful HTML/PDF output;
  • GNU make, which makes it easy to define how and when to compile a file;

Let me also thank whomever invented holidays, which is often my most productive time. Oh I cannot live without holidays.

rlp's People

Contributors

yihui avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rlp's Issues

Examples of vignettes using rlp package

Hi!

First of all I'd like to say I'm amazed by this package. It is brilliant that I can make vignette, documentation and functions at one time in 1 file :)! Moreover, documentation possibilities have never been so broad for me, since I've discovered rlp package few months ago.

I am writing this issue because I will lead workshops on Creating packages with rlp package at Warsaw University of Technology because of workshops on the processing and presentation of data that we lead for free with my friends from Data Science Students Union and foundation for statistics SmarterPoland.pl : here is the event on facebook, unfortunately in polish.

I am writing to ask you, have you ever seen someone else, besides you, that have created a vignette to his package using your's rlp package? I would like to show some original solutions on how brilliant can documenting with rlp be. I've seen your's example but maybe there are more.

I was thinking on making my own vignette for demonstration purpose and I was thinking on inserting images into vignette, as it's just a regular html. What do you think about this? I also thought I can create a vignette with shiny app inside it or with a movie/film on youtube.com with instructions on how to use this demonstration-purpose-workshop-package :) What do you think about that? Is it even possible?

Finally, I have last question about your opinion. Do you really think that all functions should be documented with rlp? Imagine a package so wealthy in number of function as base. Such vignette would be amazingly long and useless. I thought that vignette should be a tutorial through your package and shows only functionalities and main features of a package, but not every single nook of a code. What do you think about that :)? Is there really any sense to write whole package in rlp? This would be the last question I would like to ask the audience during workshop and I'm curious about your opinion.

Thanks for response,
Best,
Marcin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.