Giter Club home page Giter Club logo

texevier's Introduction

Texevier

This package helps a user set up an Elsevier template for writing academic journal reports in Rmarkdown. The setup requires very few lines of code and will get you up and running in a few seconds (provided you have all the relevent dependencies installed - see below), with a fully working and good-to-go template.

Using Texevier you can simply start writing your paper / thesis / phd in R, with a template guiding you through the most important aspects you will encounter in your writing. Your template will look as follows:

Screenshot

Installation

Make sure you have the following installed on your computer:

install.packages(c('tinytex', 'rmarkdown'))
tinytex::install_tinytex()

Alternatively, you could install the full MikTex version.

Example

After installing all three at the top, simply run the following code:

if (!require("devtools")) install.packages("devtools")
library(devtools)
devtools::install_github("Nicktz/Texevier")
library(Texevier)
# Input your directory as dir:
dir <- "YOUR DIRECTORY HERE" # Ideally choose an empty folder.
template_name = "Write_Up"
create_template(directory = dir, template_name = template_name, build_project = TRUE, open_project = TRUE)

This will automatically install all the needed files and components in the right places - allowing you to immediately focus on your paper. By setting and open_project = TRUE r, a new project file will be created in your chosen folder location, and opened with a new environment.

<template_name.Rmd> file will be created in the directory provided, which contains all the needed notes on how to write an academic paper in R. See if all your tex installations are working by opening this file, and hitting the knit button.

Motivation

Doing research in R allows you to verify your work easily. This template is designed to save the researcher time in terms of setting up a proper template for doing formal research. This is something which could feel daunting and can be time-consuming for even intermediate LaTeX and R users. This package is intended to get you started in less than a minute.

Feel free to edit the templates and use this as a starting point for your own research.

texevier's People

Contributors

nicktz avatar alphalabguy avatar

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.