Giter Club home page Giter Club logo

epurate's Introduction

A clean R Markdown template



--> See it live here.



Overview

EpuRate is a custom R Markdown template for your reports. It allows to get a uncluttered output with your contact details in the footer. It is very easy to use.

The html output looks like this.

Note that a specific version is available for:




Using it

  • Install the R package:
library(devtools)
install_github("holtzy/epuRate")
library(epuRate)
  • Open a new rmd file in Rstudio: File -> New File -> R Markdown -> From Template -> epuRate.

  • Change the Header of your document with your name, email adress, github / twitter / linkedIn details if you want to display them. You can also add a logo over the table of content.




Acknowledgment

Thanks to Florian Rohart for his help on the PCTG template. Thanks to Rstudio and its team for developing so many awesome tools.

epurate's People

Contributors

holtzy 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  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  avatar  avatar

epurate's Issues

Some Latex equation don't render correctly

Dear Yan,

I recently discovered epuRate.
To me, it is the best clean and simple Rmd template currently existing, thank you for sharing.

I ran into a strange behaviour, it would be very helpful to have your insight on it.

In the following code the E=mc² equation is rendered properly but not the (a+b)/(c+d).
The former one is correctly displayed when no template is used at all or when the readthedown template is used.

---
title: "A clean and uncluttered template"
author: "[Yan Holtz](https://github.com/holtzy)"
date: "`r format(Sys.time(), '%d %B %Y')`"
mail: "[email protected]"
linkedin: "yan-holtz-2477534a"
twitter: "r_graph_gallery"
github: "holtzy"
home: "www.yan-holtz.com"
# !!! You need to provide a logo image here !!! Or just delete the field for no logo
logo: "logo_gallery.png"
output:
  epuRate::epurate:
    toc: TRUE
    number_sections: FALSE
    code_folding: "hide"
---


# LaTeX equations

\[
E = m \times c^2
\]

\[
\frac{a+b}{c-d}
\]

image

Thanks

Footer icon not displayed properly

Footer icons are not displayed properly within my html output file as shown below:

image

Nevertheless the links work fine.
Is there anything in perticular to do, in addition of populating the info/links (linkedin: "user" for instance) in the *.Rmd header, to have them working?

The html code generated by epuRate at the end of the html output file appears the same has the default template:

<!-- Add font awesome icons -->
<p style="text-align: center;">
    	<a href="https://www.linkedin.com/in/user" class="fa fa-linkedin"></a>
  </p>

fetching remote resource failed due to proxy ?

Hi Yan,

Thanks for the beautiful work on epuRate !

I have some issues knitting "A clean and uncluttered template" which I guess are due to our corporate proxy refusing to return https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css . As I can access it easily from a web browser, I am wondering if there would be a way to save it locally and indicate to epuRate the local address instead of the remote one.

The error received :

Could not fetch https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css
HttpExceptionRequest Request {  
  host                 = "cdnjs.cloudflare.com"  
  port                 = 443  
  secure               = True  
  requestHeaders       = []  
  path                 = "/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"  
  queryString          = ""  
  method               = "GET"  
  proxy                = Nothing  
  rawBody              = False  
  redirectCount        = 10  
  responseTimeout      = ResponseTimeoutDefault  
  requestVersion       = HTTP/1.1  
}  
 (ConnectionFailure user error (Network.Socket.gai_strerror not supported: 11001))  
Error: pandoc document conversion failed with error 61  
In addition: Warning messages:  
1: Removed 10 rows containing missing values (position_stack).   
2: Removed 10 rows containing missing values (geom_text).   
3: Removed 16 rows containing missing values (position_stack).   
4: Removed 16 rows containing missing values (geom_text).   
5: Removed 12 rows containing missing values (position_stack).   
6: Removed 12 rows containing missing values (position_stack).   
7: Removed 12 rows containing missing values (geom_text). 
8: MathJax doesn't work with self_contained when not using the rmarkdown "default" template.
Execution halted  

Session Info if any use :

>sessionInfo()
R version 3.6.0 (2019-04-26)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 10 x64 (build 16299)

Matrix products: default

locale:
[1] LC_COLLATE=English_United Kingdom.1252  LC_CTYPE=English_United Kingdom.1252    LC_MONETARY=English_United Kingdom.1252
[4] LC_NUMERIC=C                            LC_TIME=English_United Kingdom.1252    

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

other attached packages:
[1] knitr_1.23

loaded via a namespace (and not attached):
 [1] compiler_3.6.0  htmltools_0.3.6 tools_3.6.0     yaml_2.2.0      Rcpp_1.0.1      rmarkdown_1.13  xfun_0.7       
 [8] digest_0.6.19   epuRate_0.1     evaluate_0.13

Merci if you have some time to look into that !

Package doesn't contain the templates

First, thanks for your work,

I have tried to install the package, worked well but no new templates are proposed in Rstudio.
It seems that there is no folder rmarkdown/templates in the package after installation.
I have tried to copy directly the templates in rmarkmown package folder instead.

I have also tried installing another package with some templates called "rticles". It worked well (proposing new templates directly in Rstudio dialogbox).

epuRate is not available for R v4.0

Hi @holtzy,

I've used your templates from epuRate earlier and I think they're very nice. However, I'm currently trying to use them after updating my R into v4.0. The message is:

package ‘holtzy/epuRate’ is not available (for R version 4.0.0)

Can you please help me with that? It will be very nice to use them again, thank you.

Cheers,
Camilo.

Position of TOC

I have a quite long TOC. The rendered TOC has therefore a vertical scroll bar, whereas the starting point of the TOC is still the same as if it was a short one, i.e. the TOC starts in the middle of the rendered html page.
Intuitively one could expect that the TOC starts higher, depending on its total height, in order to be fully visible (or at least at its maximum) within the document.

Is it possible to configure where the TOC starts from?

For now on, this forced me to switch to another template, which eventually I would not since I like this one :-).

TOC is not shown

I have installed epuRate as per your recommendation and knitted unchanged template including

output:
epuRate::epurate:
toc: TRUE

The html output does not show TOC - see screenshot attached.
Similar behaviour observed on my other computer (Mac)
However, occasionally, TOC was shown on MAC.

sessionInfo() R version 3.5.2 (2018-12-20) Platform: x86_64-w64-mingw32/x64 (64-bit) Running under: Windows >= 8 x64 (build 9200) Matrix products: default locale: [1] LC_COLLATE=English_United Kingdom.1252 LC_CTYPE=English_United Kingdom.1252 [3] LC_MONETARY=English_United Kingdom.1252 LC_NUMERIC=C [5] LC_TIME=English_United Kingdom.1252 attached base packages: [1] stats graphics grDevices utils datasets methods base loaded via a namespace (and not attached): [1] Rcpp_1.0.3 fansi_0.4.0 withr_2.1.2 digest_0.6.18 crayon_1.3.4 [6] assertthat_0.2.0 evaluate_0.13 rlang_0.4.2 cli_2.0.0 rstudioapi_0.10 [11] rmarkdown_1.12 tools_3.5.2 glue_1.3.0 epuRate_0.1 xfun_0.6 [16] yaml_2.2.0 compiler_3.5.2 sessioninfo_1.1.1 htmltools_0.4.0 knitr_1.22
--
 
  |  
 

Capture

Code Chunk Scroll Bar

Hello!

I'm wondering why your code sections in the example do not have horizontal scroll bars, but on my document they do exist even when the code is hidden.
image
image

Is there a way to either:
remove the horizontal scroll bar on code chunks via an option in the html and/or package?
make the code chunks slightly smaller than the main page so that the bars are removed?

Thank you for the wonderful data notebook, it's bringing a WOW factor to the articles I'm writing.

github corner linking to Holtzy page

I have noticed that the github corner is linking to the Holtzy webpage even when changing the github account in the rmarkdown header to mine. links changing are working well for the footer but it would be great if we didn't have to modificate the template to get our own page linked in the corner.

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.