Skip to content

Commit

Permalink
updated readme and added renv.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sumidu committed Nov 11, 2023
1 parent 62edb8d commit 18ba22e
Show file tree
Hide file tree
Showing 11 changed files with 2,760 additions and 21 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
^renv$
^renv\.lock$
^seminrstudio\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
Expand Down
1 change: 1 addition & 0 deletions .Rprofile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
source("renv/activate.R")
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ License: GPL (>= 3)
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1
RoxygenNote: 7.1.2
URL: https://github.com/sem-in-r/seminrstudio
BugReports: https://github.com/sem-in-r/seminrstudio/issues
Imports:
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Generated by roxygen2: do not edit by hand

export(colhex2col)
export(custom_theme_addin)
import(seminr)
23 changes: 14 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ knitr::opts_chunk$set(

# seminrstudio

<!-- badges: start -->
[![R-CMD-check](https://github.com/sem-in-r/seminrstudio/workflows/R-CMD-check/badge.svg)](https://github.com/sem-in-r/seminrstudio/actions)
<!-- badges:
[![R-CMD-check](https://github.com/sem-in-r/seminrstudio/workflows/R-CMD-check/badge.svg)](https://github.com/sem-in-r/seminrstudio/actions) start -->
[![CRAN status](https://www.r-pkg.org/badges/version/seminrstudio)](https://CRAN.R-project.org/package=seminrstudio)
[![Codecov test coverage](https://codecov.io/gh/sem-in-r/seminrstudio/branch/master/graph/badge.svg)](https://codecov.io/gh/sem-in-r/seminrstudio?branch=master)
<!-- badges: end -->
Expand All @@ -26,13 +26,8 @@ Features are made available as RStudio Addins.

## Installation

You can install the released version of seminrstudio from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("seminrstudio")
```

Alternatively you can install seminrstudio directly from Github.
You can install seminrstudio directly from Github.

```r
if(!require(remotes)) {
Expand All @@ -41,10 +36,20 @@ if(!require(remotes)) {
remotes::install_github("sem-in-r/seminrstudio")
```

Someday, you will be able to install the released version of seminrstudio from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("seminrstudio")
```

But not yet. :(



## Usage

The following tools are implemented at the moment:

- Theme Editor: A tool to design a seminr_theme
- Theme Editor: A tool to design a seminr_theme. Install the package. Load it once and you should have a new RStudio "Addin".
![](rstudio.png)

26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

# seminrstudio

<!-- badges: start -->
<!-- badges:
[![R-CMD-check](https://github.com/sem-in-r/seminrstudio/workflows/R-CMD-check/badge.svg)](https://github.com/sem-in-r/seminrstudio/actions) start -->

[![R-CMD-check](https://github.com/sem-in-r/seminrstudio/workflows/R-CMD-check/badge.svg)](https://github.com/sem-in-r/seminrstudio/actions)
[![CRAN
status](https://www.r-pkg.org/badges/version/seminrstudio)](https://CRAN.R-project.org/package=seminrstudio)
[![Codecov test
Expand All @@ -17,14 +17,7 @@ The goal of seminrstudio is to to provide a UI based interface to the

## Installation

You can install the released version of seminrstudio from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("seminrstudio")
```

Alternatively you can install seminrstudio directly from Github.
You can install seminrstudio directly from Github.

``` r
if(!require(remotes)) {
Expand All @@ -33,8 +26,19 @@ if(!require(remotes)) {
remotes::install_github("sem-in-r/seminrstudio")
```

Someday, you will be able to install the released version of
seminrstudio from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("seminrstudio")
```

But not yet. :(

## Usage

The following tools are implemented at the moment:

- Theme Editor: A tool to design a seminr\_theme
- Theme Editor: A tool to design a seminr_theme. Install the package.
Load it once and you should have a new RStudio “Addin”.
![](rstudio.png)
20 changes: 20 additions & 0 deletions man/colhex2col.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 18ba22e

Please sign in to comment.