Skip to content

Commit

Permalink
Merge pull request #23 from jasenfinch/devel
Browse files Browse the repository at this point in the history
v0.5.8
  • Loading branch information
jasenfinch committed Jan 7, 2022
2 parents 617107e + aedd732 commit 4ad7bea
Show file tree
Hide file tree
Showing 28 changed files with 87 additions and 36 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: projecttemplates
Title: Project Templates for Reproducible Research and Analyses
Version: 0.5.7
Version: 0.5.8
Authors@R:
person(given = "Jasen",
family = "Finch",
Expand Down
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# projecttemplates 0.5.8

* The `renv` directory is now included in the generated `.dockerignore` file if argument `renv = TRUE`.

* The RStudio project file is now created even if the project template is generated outside of RStudio.

* Errors encountered during the retrieval of the git signature are now reported during git initialisation.

# projecttemplates 0.5.7

* Script header added to generated `R/utils.R` file.
Expand Down
19 changes: 16 additions & 3 deletions R/docker.R
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,21 @@ docker run -v $(pwd):/home/{project_name_directory} {str_to_lower(project_name_d
") %>%
write(file = str_c(project_directory,'/README.md'),append = TRUE)

'_targets
data
exports' %>%
dockerIgnore(project_directory,
renv)
}

dockerIgnore <- function(project_directory,renv = TRUE){

ignores <- c('_targets',
'data',
'exports')

if (isTRUE(renv)){
ignores <- c(ignores,
'renv')
}

ignores %>%
write(file = str_c(project_directory,'/.dockerignore'))
}
6 changes: 4 additions & 2 deletions R/git.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ createGit <- function(project_directory,type,ignore = c('.Rhistory','.Rproj.user
git_add('.*',repo = project_directory)
git_add('*',repo = project_directory)

git_signature_status <- try(git_signature_default(),silent = TRUE)
git_signature_status <- try(git_signature_default(repo = project_directory))

if (class(git_signature_status) == 'character') {
if (class(git_signature_status) == 'try-error') {
message('Errors encountered retrieving git credentials. Skipping initial commit.')
} else {
git_commit('Initial commit',repo = project_directory)
}
}
28 changes: 25 additions & 3 deletions R/skeleton.R
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ projectSkeleton <- function(project_directory,force = FALSE){

dir.create(project_directory,recursive = TRUE)

if (isAvailable()) {
initializeProject(project_directory)
}
rsProject(project_directory)

dir.create(str_c(project_directory,'R','functions',sep = '/'),recursive = TRUE)

Expand All @@ -52,4 +50,28 @@ projectSkeleton <- function(project_directory,force = FALSE){

dir.create(str_c(project_directory,'exports',sep = '/'))

}

rsProject <- function(project_directory){
if (isAvailable()) {
initializeProject(project_directory)
} else {
'Version: 1.0
RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default
EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8
RnwWeave: Sweave
LaTeX: pdfLaTeX' %>%
write(file = str_c(project_directory,
'/',
basename(project_directory),
'.Rproj'))
}
}
2 changes: 1 addition & 1 deletion docs/404.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE.html

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

10 changes: 5 additions & 5 deletions docs/authors.html

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

2 changes: 1 addition & 1 deletion docs/index.html

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

8 changes: 7 additions & 1 deletion docs/news/index.html

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

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ pandoc: 2.11.4
pkgdown: 2.0.1
pkgdown_sha: ~
articles: {}
last_built: 2021-12-17T12:11Z
last_built: 2022-01-07T15:55Z
urls:
reference: https://jasenfinch.github.io/projecttemplates/reference
article: https://jasenfinch.github.io/projecttemplates/articles
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/createGit.html

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

2 changes: 1 addition & 1 deletion docs/reference/createGithub.html

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

2 changes: 1 addition & 1 deletion docs/reference/docker.html

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

2 changes: 1 addition & 1 deletion docs/reference/githubActions.html

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

2 changes: 1 addition & 1 deletion docs/reference/index.html

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

2 changes: 1 addition & 1 deletion docs/reference/output.html

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

2 changes: 1 addition & 1 deletion docs/reference/projectDirectory.html

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

2 changes: 1 addition & 1 deletion docs/reference/projectSkeleton.html

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

2 changes: 1 addition & 1 deletion docs/reference/projectTypes.html

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

2 changes: 1 addition & 1 deletion docs/reference/readme.html

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

2 changes: 1 addition & 1 deletion docs/reference/renvInitialise.html

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

2 changes: 1 addition & 1 deletion docs/reference/targets.html

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

2 changes: 1 addition & 1 deletion docs/reference/targetsPipeline.html

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

2 changes: 1 addition & 1 deletion docs/reference/targetsRun.html

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

2 changes: 1 addition & 1 deletion docs/reference/targetsScript.html

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

2 changes: 1 addition & 1 deletion docs/reference/template.html

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

2 changes: 1 addition & 1 deletion docs/reference/utils.html

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

0 comments on commit 4ad7bea

Please sign in to comment.