proj_test: Analyze project for reproducibility

In baumer-lab/fertile: Creating Optimal Conditions for Reproducibility

Description

Analyze project for reproducibility

Usage

proj_test(path = ".")

proj_analyze(path = ".")

proj_analyze_files(path = ".")

proj_suggest_moves(files)

proj_move_files(suggestions, execute = TRUE)

proj_analyze_pkgs(path = ".")

proj_analyze_paths(path = ".")

Arguments

path	Path to project root
files	List of files returned by proj_analyze_files
suggestions	List of suggestsions returned by proj_suggest_moves
execute	Do you want to actually move the files to their recommended location?

Value

A fertile object

proj_test

Create a full report of project reproducibility. Includes: packages referenced in code, files in the directory and suggestions for moving them, and a list of paths that are not portable.

proj_test("your project directory")

proj_analyze

Very similar to proj_test, except that this function does NOT include a report of paths that are not portable.

proj_analyze("your project directory")

proj_analyze_files

Provides a report of files present in a provided project directory. Includes information about file size, extension, and a guess about the file type.

proj_analyze_files("your project directory")

proj_suggest_moves

Takes a list of files returned by proj_analyze_files and makes suggestions or where the files should be moved, as well as a command for how to move them there.

files <- proj_analyze_files("your project directory")

proj_suggest_moves(files)

proj_move_files

Execute the suggested commands returned by proj_suggest_moves.

files <- proj_analyze_files("your project directory")

suggestions <- proj_suggest_moves(files)

proj_move_files(suggestions)

proj_analyze_pkgs

Returns all of the packages loaded in R code files as well as the name of the files where they were referenced.

proj_analyze_pkgs("your project directory")

proj_analyze_paths

Looks at paths used in R code located in a project directory and reports paths that are absolute or that reference a location outside the project directory.

proj_analyze_paths("your project directory")

baumer-lab/fertile documentation built on April 19, 2021, 12:01 a.m.