Install conflr from CRAN with:
Alternatively, if you need the development version, install it with:
# install.packages("devtools") devtools::install_github("line/conflr")
conflr uses these environmental variables to access your Confluence.
CONFLUENCE_URL: The base URL of your Confluence. e.g.
https://confluence.example.com(On Atlassian Cloud,
CONFLUENCE_USERNAME: Your username (On Atlassian Cloud, your email address).
CONFLUENCE_PASSWORD: Your password (On Atlassian Cloud, your API token. For more details about API token, please read the official document).
There are several ways to set these environmental variables. The quickest way is to enter in the popups that are displayed when you run the addin (see Usages section below). The inputs are cached in the environmental variables listed above by default.
Another way is to set the variables in the
.Renviron file (you can open the file with
usethis::edit_r_environ()). For example, you can set the base URL in the file as the following.
conflr provides the following ways to post R Markdown documents to Confluence.
conflr::confluence_documenton the YAML front-matter
(Caution for those who are not familiar with R Markdown: R Markdown’s powerfulness allows you to execute arbitrary code; be sure about what the code does before clicking “Post to Confluence”!)
Then, you will be asked your username and password.
If you don’t use RStudio, you can use
confl_create_post_from_Rmd(). The basic usage is
If you want to use this function without interaction, specify
interactive = FALSE. This skips any confirmations or previews.
confl_create_post_from_Rmd("~/path/to/your.Rmd", interactive = FALSE)
Note that, if you want to run this periodically, you also need to set
update = TRUE to allow conflr to overwrite the existing page.
confl_create_post_from_Rmd("~/path/to/your.Rmd", interactive = FALSE, update = TRUE)
conflr’s functionality is also available as a custom R Markdown format; You can specify
output in the front matter of your R Markdown document.
For example, if you set the following front matter, pressing
Knit button on RStudio (or running
rmarkdown::render()) will publish the R Markdown document to Confluence.
--- title: "title1" output: conflr::confluence_document: space_key: "space1" update: true --- ...
conflr recognizes these options:
conflr_supported_syntax_highlighting: A character vector of languages that your Confluence supports the syntax highlighting in addition to the default languages (by default,
CONFLUENCE_PASSWORDafter the page is successfully uploaded via addin.
conflr doesn’t support htmlwidgets-based packages like leaflet and plotly. Instead, you can embed the screenshot by setting
screenshot.force = TRUE in the chunk option (c.f. https://bookdown.org/yihui/bookdown/html-widgets.html).
conflr is also a (non-complete) binding to Confluence’s REST API. These low-level functions might be useful when you need to access to your Confluence programmatically.
library(conflr) # list pages res <- confl_list_pages(spaceKey = "foo") purrr::map_chr(res$results, "id") # get page info page <- confl_get_page(res$results[]$id) page$title # create a page new_page <- confl_post_page( spaceKey = "foo", title = "Test", body = glue::glue( '<ac:structured-macro ac:name="code"> <ac:plain-text-body><![CDATA[this is my code]]></ac:plain-text-body> </ac:structured-macro> ')) new_page$`_links`
Copyright (C) 2019 LINE Corporation : you can redistribute it and/or modify This program is free software it under the terms of the GNU General Public License as published by3. the Free Software Foundation, version in the hope that it will be useful, This program is distributed but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See thefor more details. GNU General Public License You should have received a copy of the GNU General Public License<http://www.gnu.org/licenses/>.along with this program. If not, see
See LICENSE.md for more detail.