R/help_serac.R

In rosalieb/serac: ShortlivEd RAdionuclide Chronology of recent sediment cores

#' serac help
#'
#' @description Give a help message
#'
#' @export
#' @keywords age-depth modelling
#' @keywords visualisation
#' @examples serac_input_formatting('PB06')
#'

help_serac  <- function() {cat("Hi there, welcome to serac.\n0) DID YOU INSTALL THE VIGNETTE?\n   If you download our package using the devtools library:\n         devtools::install_github('rosalieb/serac', build_vignettes = TRUE)\n   tape in the console\n         vignette('serac')\n   to access the vignette (nicer looking help!). \n1) GET STARTED\n   In the directory (folder) your working in, you should have created a folder named 'Cores'.\n   Within this folder, you will be able to store all your different projects.\n   Pick a name for your project - we recommend using the name of the sediment sequence.\n   Within this folder, you need to have at least one .txt file, named the exact same way\n   than your sub-folder.\n   Here are some requirements for this .txt file:\n          - saved using tabulations as delimitators;\n          - points for decimal delimitators;\n          - all depths must be in mm;\n          - there are two format possible to enter depths:\n                (1) one column depth + one column thickness\n                (2) upper and lower limits of your sample, \n                    ID with 'depth_top' OR 'depth_min' and 'depth_bottom' OR 'depth_max';\n          - 'density' must be in g/cm3;\n          - your different radioelement measurements, named 'Pb210', 'Pb210ex', 'Cs137',\n             'Am241';\n          - the error for each measurements, named 'Pb210_er', 'Pb210ex_er','Cs137_er', \n            'Am241_er'.\n2) HAVE A FIRST LOOK AT YOUR DATA\n   You can have a first look at your data just by typing into your console:\n           serac(name='mydata',coring_yr=2010)\n   Of course, 'mydata' must match the folder name you just created, and the coring\n   year might not be 2010.\n3) TEST HYPOTHESES\n   Using the different argument, you can test different hypotheses, and chose what\n   to plot on your output figure.\n4) OTHER FILES FORMAT\n   Core picture extension should be .jpg (not .jpeg, not .png, not .pdf).\n   If you're adding a proxy or varves counting, the depth column must contain the\n   average depth of the sample (in mm) and then your data in other columns.\n   Again, you must save as .txt (tabulations separators).\n5) COMMON ERRORS\n   If you get errors, first make sure your data are in the correct format\n   If the message is related to the size of the window being too small, try extending\n   your plot window (you can do that at least in R studio).\n   Try setting preview to FALSE too.\n   It is a silly problem we could not fix - solutions depends on the platform you use.\n   We decided we didn't want serac to be utilisable on only one platform.\n6) PACKAGES\n   serac uses packages, they will be downloaded automatically.\n   Make sure to be connected to internet the first time you run the code so the\n   packages can be added to your library.\n7) CONTACT US\n   If the problem persists and it feels like you tried everything, we're happy to help.\n   Send us your file in the correct format (as described above) + the line of code you\n   used + the error message you got.")}