Package: preregr 0.2.9

Gjalt-Jorn Peters

preregr: Specify (Pre)Registrations and Export Them Human- And Machine-Readably

Preregistrations, or more generally, registrations, enable explicit timestamped and (often but not necessarily publicly) frozen documentation of plans and expectations as well as decisions and justifications. In research, preregistrations are commonly used to clearly document plans and facilitate justifications of deviations from those plans, as well as decreasing the effects of publication bias by enabling identification of research that was conducted but not published. Like reporting guidelines, (pre)registration forms often have specific structures that facilitate systematic reporting of important items. The 'preregr' package facilitates specifying (pre)registrations in R and exporting them to a human-readable format (using R Markdown partials or exporting to an 'HTML' file) as well as human-readable embedded data (using 'JSON'), as well as importing such exported (pre)registration specifications from such embedded 'JSON'.

Authors:Gjalt-Jorn Peters [aut, cre], Szilvia Zörgő [ctb], Olmo den Akker [ctb], Aleksandra Lazić [ctb], Thomas Gültzow [ctb]

preregr_0.2.9.tar.gz
preregr_0.2.9.tar.gz(r-4.5-noble)preregr_0.2.9.tar.gz(r-4.4-noble)
preregr_0.2.9.tgz(r-4.4-emscripten)preregr_0.2.9.tgz(r-4.3-emscripten)
preregr.pdf |preregr.html
preregr/json (API)

# Install 'preregr' in R:
install.packages('preregr', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://gitlab.com/r-packages/preregr

Pkgdown:https://preregr.opens.science

Datasets:

3.98 score 1 scripts 182 downloads 55 exports 10 dependencies

Last updated 2 years agofrom:c75a5126e3. Checks:OK: 1 NOTE: 1. Indexed: yes.

TargetResultDate
Doc / VignettesOKDec 18 2024
R-4.5-linuxNOTEDec 18 2024

Exports:asrtassertbipiped_value_to_vectorbipiped_values_to_vectorcat0dcsndecidedecisionfirst_valid_valueform_add_instructionform_add_itemform_add_sectionform_createform_fromSpreadsheetform_knitform_showform_to_htmlform_to_jsonform_to_rmd_templateform_to_xlsxformsheadingidSlugimport_from_htmljstfjustifynumber_as_xl_dateoptsprereg_initializeprereg_justifyprereg_knit_item_contentprereg_next_itemprereg_show_item_completionprereg_show_item_contentprereg_spec_to_htmlprereg_spec_to_jsonprereg_spec_to_pdfprereg_spec_to_yamlprereg_specifyrandomSlugrbind_df_listrbind_dfsread_spreadsheetrepeatStrrepStrserialize_dfserialized_data_to_dfssourcesrcestructure_for_serializationvalidate_valuevecTxtvecTxtQwrapVectoryaml_to_prereg_spec

Dependencies:clidigestevaluatehighrjsonliteknitrrlangrmdpartialsxfunyaml

Create an R Markdown template from a form

Rendered fromrmd_template_from_form.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Creating a (pre)registration form

Rendered fromcreating_prereg_form.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2021-09-30
Started: 2021-09-30

Creating a form from a spreadsheet

Rendered fromcreating_form_from_spreadsheet.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Form: Generalized Systematic Review Registration Form (v1)

Rendered fromform_genSysRev_v1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-05-05
Started: 2023-05-05

Form: Inclusive General-Purpose Registration Form (v1.0)

Rendered fromform_generalPurpose_v1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-10-13

Form: Inclusive General-Purpose Registration Form (v1.1)

Rendered fromform_generalPurpose_v1_1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2022-01-12

Form: Inclusive Systematic Review Registration Form (v0.92)

Rendered fromform_inclSysRev_v0_92.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Form: Inclusivity & Diversity Add-on for preregistration forms (v0.1)

Rendered fromform_inclDivAddon_v0_1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2023-03-05

Form: OSF Prereg form (v1)

Rendered fromform_OSFprereg_v1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Form: Preregistration Template for Qualitative and Quantitative Ethnographic Studies (v0.93)

Rendered fromform_preregQE_v0_93.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Form: Preregistration Template for Qualitative and Quantitative Ethnographic Studies (v0.94)

Rendered fromform_preregQE_v0_94.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2022-01-12

Form: Preregistration Template for Qualitative and Quantitative Ethnographic Studies (v0.95)

Rendered fromform_preregQE_v0_95.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2023-03-05

Form: Preregistration Template for Secondary Data Analysis (v1)

Rendered fromform_prereg2D_v1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2022-01-12

Form: Psychological Research Preregistration-Quantitative (aka PRP-QUANT) Template (v1)

Rendered fromform_prpQuant_v1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Form: Qualitative Preregistration Template (v1)

Rendered fromform_OSFqual1_v1.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2022-08-22

Importing a (pre)registration form from embedded JSON from a URL

Rendered fromimporting_form_from_url.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Importing a (pre)registration from embedded JSON from a URL

Rendered fromimporting_pregistration_from_url.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Intro to preregr

Rendered frompreregr.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2023-03-05

Specifying preregistration content

Rendered fromspecifying_prereg_content.Rmdusingknitr::rmarkdownon Dec 18 2024.

Last update: 2023-03-05
Started: 2021-09-30

Readme and manuals

Help Manual

Help pageTopics
Convert a "bipiped" value (or vector of values) to a vectorbipiped_values_to_vector bipiped_value_to_vector
Concatenate to screen without spacescat0
An example (pre)registration specification using the Inclusive General-Purpose Registration FormexamplePrereg_1
Select the first valid valuefirst_valid_value
Add an instruction, section, or item to a (pre)registration formform_add_instruction form_add_item form_add_section
A mostly empty example form specificationform_almostEmptyForm
Create a new (pre)registration formform_create
Import a (pre)registration form specification from a spreadsheetform_fromSpreadsheet
Inclusive General-Purpose Registration Formform_generalPurpose_v1 form_generalPurpose_v1_1 generalPurpose_v1 generalPurpose_v1_1
Generalized Systematic Review Registration Formform_genSysRev_v1
Inclusivity & Diversity Add-on for preregistration formsform_inclDivAddon_v0_1 inclDivAddon_v0_1
Inclusive Systematic Review Registration Formform_inclSysRev_v0_92 inclSysRev_v0_92
Knit a (pre)registration form into an Rmd fileform_knit
OSF Prereg formform_OSFprereg_v1 OSFprereg_v1
Qualitative Preregistration Templateform_OSFqual1_v1 OSFqual1_v1
Preregistration Template for Secondary Data Analysisform_prereg2D_v1 prereg2D_v1
Preregistration Template for Qualitative and Quantitative Ethnographic Studiesform_preregQE_v0_93 form_preregQE_v0_94 form_preregQE_v0_95 preregQE_v0_93 preregQE_v0_94 preregQE_v0_95
Psychological Research Preregistration-Quantitative (aka PRP-QUANT) Templateform_prpQuant_v1 prpQuant_v1
Show a (pre)registration formform_show
Convert a (pre)registration form to htmlform_to_html
Convert a (pre)registration specification to YAML or JSONform_to_json prereg_spec_to_json prereg_spec_to_yaml print.preregr_json print.preregr_yaml
Convert a (pre)registration form to an R Markdown templateform_to_rmd_template print.preregr_rmd_template
Export a (pre)registration form to an Excel spreadsheetform_to_xlsx
Included (pre)registration formsforms
Print a headingheading
Import a (pre)registration specification from JSON embedded in HTMLimport_from_html
Convert a number to a date using Excel's systemnumber_as_xl_date
Options for the preregr packageget opts reset set
Initialize a (pre)registrationprereg_initialize
Justify (and optionally specify) the content for one or more (pre)registration itemsprereg_justify
Knit the specified content for the items in a (pre)registration into an Rmd fileprereg_knit_item_content
Show the next item to specify content forprereg_next_item
Show which items in a (pre)registration have been completedprereg_show_item_completion
Show the specified content for the items in a (pre)registrationprereg_show_item_content
Convert a (pre)registration specification to htmlprereg_spec_to_html
Convert a (pre)registration specification to PDFprereg_spec_to_pdf
Specify the content for one or more (pre)registration itemsprereg_specify
Generate a random slugidSlug randomSlug
Bind lots of dataframes together rowwiserbind_df_list
Simple alternative for rbind.fill or bind_rowsrbind_dfs
Convenience function to read spreadsheet-like filesread_spreadsheet
Repeat a string a number of timesrepeatStr repStr
"Serialize" a data frame or (pre)registration specificationserialize_df structure_for_serialization
In an object imported from YAML or JSON, convert some elements to dataframesserialized_data_to_dfs
Programmatically constructing justifier elementsasrt assert dcsn decide decision jstf justify source srce
Validate a valuevalidate_value
Easily parse a vector into a character valuevecTxt vecTxtQ
Wrap all elements in a vectorwrapVector
Convert a (pre)registration specification from YAML or JSONyaml_to_prereg_spec