uploadToOverleaf {BiocWorkflowTools} | R Documentation

## Upload a LaTeX project to Overleaf

### Description

Upload a LaTeX project to Overleaf

### Usage

    uploadToOverleaf(path, forceNewProject = FALSE, openInBrowser = FALSE,
      git = FALSE)

### Arguments

`path` | File path to a directory or a single zip file to be uploaded.
`forceNewProject` | Logical specifying if a new Overleaf project should be create, even if the function detects this document has already has an associated project. Default value is FALSE.
`openInBrowser` | Boolean determining whether to open a browser at the created Overleaf project or not. Default value is FALSE.
`git` | Boolean specifying whether to initialize a local clone of the Overleaf project's git repository

### Value

The URL where the uploaded project can be accessed is printed to the screen and invisibly returned from the function. If the argument `openInBrowser` is set to `TRUE`, then the Overleaf project page will automatically open in the default browser.

### Examples

    ## Not run:
    example_Rmd <- system.file('examples/f1000_software_example.Rmd',
                               package = "BiocWorkflowTools")
    output_dir <- file.path(tempdir(), 'example')
    markdownToLatex(input = example_Rmd, output = output_dir,
                    compress = TRUE)

    ## don't run this code chunk in the example as we don't want to spam Overleaf
    zip_file <- paste0(output_dir, '.zip')
    uploadToOverleaf(files = zip_file, openInBrowser = TRUE)

    ## End(Not run)

[Package BiocWorkflowTools version 1.4.2 Index]